Export (0) Print
Expand All

DictionaryKeyPropertyAttribute Class

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.

System.Object
  System.Attribute
    System.Windows.Markup.DictionaryKeyPropertyAttribute

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

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

The DictionaryKeyPropertyAttribute type exposes the following members.

  NameDescription
Public methodDictionaryKeyPropertyAttributeInitializes a new instance of the DictionaryKeyPropertyAttribute class.
Top

  NameDescription
Public propertyNameGets the name of the property that provides the implicit key value.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
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.)
Top

  NameDescription
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.)
Top

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:

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

.NET Framework

Supported in: 4.6, 4, 3.5 SP1, 3.0 SP2

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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