DictionaryKeyPropertyAttribute Class
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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.

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

SystemObject
   SystemAttribute
    System.Windows.MarkupDictionaryKeyPropertyAttribute

[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false, 
	Inherited = true)]
public sealed class DictionaryKeyPropertyAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = false, 
	Inherited = true)]
public ref class DictionaryKeyPropertyAttribute sealed : Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false,
    Inherited = true)>]
type DictionaryKeyPropertyAttribute = 
    class
        inherit Attribute
    end
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := False,
	Inherited := True)>
Public NotInheritable Class DictionaryKeyPropertyAttribute
	Inherits Attribute
NameDescription
System_CAPS_pubmethod DictionaryKeyPropertyAttribute

Initializes a new instance of the DictionaryKeyPropertyAttribute class.

NameDescription
System_CAPS_pubproperty

Gets the name of the property that provides the implicit key value.

System_CAPS_pubproperty

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

NameDescription
System_CAPS_pubmethod Equals

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod GetHashCode

Returns the hash code for this instance.(Inherited from Attribute.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod 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.)

System_CAPS_pubmethod Match

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetIDsOfNames

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfo

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeInvoke

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

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.

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
Available since 3.0

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

Return to top