Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
RuntimeNamePropertyAttribute Class
Collapse the table of content
Expand the table of content

RuntimeNamePropertyAttribute Class

Represents a type-level attribute that reports which property of the type maps to the XAML x:Name attribute.


Namespace:  System.Windows.Markup
Assembly:  System.Xaml (in System.Xaml.dll)

public sealed class RuntimeNamePropertyAttribute : Attribute

The RuntimeNamePropertyAttribute type exposes the following members.

Public methodRuntimeNamePropertyAttributeInitializes a new instance of the RuntimeNamePropertyAttribute class.

Public propertyNameGets the name of the runtime name property that is specified by this RuntimeNamePropertyAttribute.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)

The property that is specified in the RuntimeNamePropertyAttribute must be of type String and must be read/write.

Frameworks might attribute a certain property of one its architectural base elements to be the XAML name equivalent. This is done so that the concept of a XAML name in a XAML namescope set at XAML load time is available to a framework's programming model at run time.

A XAML name value must use the XamlName Grammar.

In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, RuntimeNamePropertyAttribute is in the System.Xaml assembly. For more information, see Types Migrated from WPF to System.Xaml.

WPF Usage Notes

An example of an existing class in Windows Presentation Foundation (WPF) where the RuntimeNamePropertyAttribute is applied is FrameworkElement. The Name property on FrameworkElement is attributed with RuntimeNamePropertyAttribute, which results in any FrameworkElement derived class also using Name as its run-time name property.

In general, you do not typically need to apply this attribute in WPF unless you are implementing a new or FrameworkElement-parallel framework-level class. x:Name should take precedence over the run-time name property if both exist as attributes on an element, and a XAML processor implementation generally throws in this case.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2015 Microsoft