Edit

RuntimeNamePropertyAttribute Class

Definition

Namespace:
System.Windows.Markup
Assembly:
System.Xaml.dll

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

public ref class RuntimeNamePropertyAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Class)]
public sealed class RuntimeNamePropertyAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Class)>]
type RuntimeNamePropertyAttribute = class
    inherit Attribute
Public NotInheritable Class RuntimeNamePropertyAttribute
Inherits Attribute
Inheritance
Object
Attribute
RuntimeNamePropertyAttribute
Attributes
AttributeUsageAttribute

Remarks

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.

Constructors

Name Description
RuntimeNamePropertyAttribute(String)

Initializes a new instance of the RuntimeNamePropertyAttribute class.

Properties

Name Description
Name

Gets the name of the runtime name property that is specified by this RuntimeNamePropertyAttribute.

Applies to

See also