Share via

DataSource.PersistedName Property

  • Reference

Definition

Namespace:
Microsoft.Build.Framework.XamlTypes
Assembly:
Microsoft.Build.Framework.dll
Package:
Microsoft.Build.Framework v15.9.20
Package:
Microsoft.Build.Framework v16.11.0
Package:
Microsoft.Build.Framework v17.11.4
Source:
DataSource.cs

Gets or sets the actual MSBuild property name used to read/write the value of this property. Applicable only to DataSource objects attached to properties.

public:
 property System::String ^ PersistedName { System::String ^ get(); void set(System::String ^ value); };
public string PersistedName { get; set; }
public string PersistedName { [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] get; [System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")] set; }
member this.PersistedName : string with get, set
[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]
[<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]
member this.PersistedName : string with get, set
Public Property PersistedName As String

Property Value

String

The MSBuild property name to use; or null to use the Name as the MSBuild property name.

Attributes
TargetedPatchingOptOutAttribute

Remarks

The persisted name will usually be the same as the property name as it appears in the Rule and the value of this property can therefore be left at is default of null. Since property names must be unique but need not be unique in the persisted store (due to other differences in the data source such as item type) there may be times when Rule property names must be changed to be unique in the XAML file, but without changing how the property is persisted in the MSBuild file. It is in those cases where this property becomes useful.

It may also be useful in specialized build environments where property names must differ from the normally used name in order to maintain compatibility with the project system.

Applies to