DictionaryKeyPropertyAttribute Class

Definition

Namespace:

System.Windows.Markup

Assembly:

System.Xaml.dll

Specifies a property of the associated class that provides the implicit key value. Implicit keys are used for keys rather than explicit x:Key attributes defined in XAML for an item in IDictionary collections.

public ref class DictionaryKeyPropertyAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=true)]
public sealed class DictionaryKeyPropertyAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=true)>]
type DictionaryKeyPropertyAttribute = class
    inherit Attribute

Public NotInheritable Class DictionaryKeyPropertyAttribute
Inherits Attribute

Inheritance

Object

Attribute

DictionaryKeyPropertyAttribute

Attributes

AttributeUsageAttribute

Remarks

Items in an IDictionary dictionary (such as the WPF ResourceDictionary) require a key. In XAML, the key is typically specified by x:Key attribute in the XAML markup for each item in the IDictionary. The DictionaryKeyPropertyAttribute is applied to classes that work with an implicit key, where the key to use for IDictionary inclusion comes from a different property value in the class. Instances of the class applying the DictionaryKeyPropertyAttribute can be included in an IDictionary without an explicit key so long as the property referenced by IDictionary has a value that is valid as a key in that dictionary implementation.

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

WPF Usage Notes

The following list references examples of WPF APIs where this attribute is applied:

• ControlTemplate.TargetType

• DataTemplate.DataTemplateKey

• Style.TargetType

For more information about the WPF resource dictionary implications of DictionaryKeyPropertyAttribute, see XAML Resources.

Constructors

DictionaryKeyPropertyAttribute(String)

Initializes a new instance of the DictionaryKeyPropertyAttribute class.

Properties

Name	Gets the name of the property that provides the implicit key value.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• ResourceDictionary
• XAML-related CLR attributes for custom types and libraries
• Define custom types for use with .NET XAML Services
• XAML Services
• x:Key Attribute