DictionaryKeyPropertyAttribute Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
- Attributes
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 .NET Framework versions prior to 4, 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.
Constructors
| Name | Description |
|---|---|
| DictionaryKeyPropertyAttribute(String) |
Initializes a new instance of the DictionaryKeyPropertyAttribute class. |
Properties
| Name | Description |
|---|---|
| Name |
Gets the name of the property that provides the implicit key value. |