ComponentResourceKey Class

Definition

Defines or references resource keys based on class names in external assemblies, as well as an additional identifier.

public ref class ComponentResourceKey : System::Windows::ResourceKey
[System.ComponentModel.TypeConverter(typeof(System.Windows.Markup.ComponentResourceKeyConverter))]
public class ComponentResourceKey : System.Windows.ResourceKey
[<System.ComponentModel.TypeConverter(typeof(System.Windows.Markup.ComponentResourceKeyConverter))>]
type ComponentResourceKey = class
    inherit ResourceKey
Public Class ComponentResourceKey
Inherits ResourceKey
Inheritance
ComponentResourceKey
Attributes

Remarks

For XAML information, see ComponentResourceKey Markup Extension.

This class implements an object type that is useful for creating keys that are based on types in assemblies plus an identifier. Because you define or reference the type, you do not need to request a specific ResourceDictionary, and more than one set of resources can exist in the assembly, each differentiated by the type of their ComponentResourceKey.

There are two ways to define a ComponentResourceKey.

If you want an easily accessible key, you can define a static property on your control class code that returns a ComponentResourceKey, constructed with a TypeInTargetAssembly that exists in the external resource assembly, and a ResourceId. The key can be used for defining alternate default styles for controls in an assembly, by swapping the original external resource assembly for a custom one. You can also define a named resource part within a larger control style or template to expose a customization entry point. This is particularly useful if you are defining a theme resource dictionary for your control.

You can also use the XAML ComponentResourceKey Markup Extension in verbose syntax directly to create a loose instance of the key. This is useful if you want to declare private resources from other assemblies that are less discoverable to customize.

Constructors

ComponentResourceKey()

Initializes a new instance of the ComponentResourceKey class.

ComponentResourceKey(Type, Object)

Initializes a new instance of the ComponentResourceKey class, specifying the Type that defines the key, and an object to use as an additional resource identifier.

Properties

Assembly

Gets the assembly object that indicates which assembly's dictionary to look in for the value associated with this key.

ResourceId

Gets or sets a unique identifier to differentiate this key from others associated with this type.

TypeInTargetAssembly

Gets or sets the Type that defines the resource key.

Methods

Equals(Object)

Determines whether the provided object is equal to the current ComponentResourceKey.

GetHashCode()

Returns a hash code for this ComponentResourceKey.

GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ProvideValue(IServiceProvider)

Returns this ResourceKey. Instances of this class are typically used as a key in a dictionary.

(Inherited from ResourceKey)
ToString()

Gets the string representation of a ComponentResourceKey.

Applies to