Class DependencyPropertyExtensions

Contains utility methods for registering dependency properties with extended metadata.

Inheritance

System.Object

DependencyPropertyExtensions

Namespace: Telerik.Windows

Assembly: Telerik.Windows.Controls.dll

Syntax

public static class DependencyPropertyExtensions : Object

Methods

ClearValue(DependencyObject, DependencyPropertyKey)

Clears the local value of the read only property.

Declaration

public static void ClearValue(this DependencyObject element, DependencyPropertyKey key)

Parameters

System.Windows.DependencyObject element The element to clear the value to.

DependencyPropertyKey key The key for the dependency property to be cleared.

CoerceValue(DependencyObject, DependencyProperty)

Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.

Declaration

public static void CoerceValue(this DependencyObject element, DependencyProperty dependencyProperty)

Parameters

System.Windows.DependencyObject element The element to set the value to.

System.Windows.DependencyProperty dependencyProperty The identifier for the dependency property to coerce.

Register(String, Type, Type)

Registers a dependency property with the specified property name, property type, owner type, and property metadata.

Declaration

public static DependencyProperty Register(string name, Type propertyType, Type ownerType)

Parameters

System.String name The name of the dependency property to register.

System.Type propertyType The type of the property.

System.Type ownerType The owner type that is registering the dependency property.

Returns

System.Windows.DependencyProperty A dependency property identifier that should be used to set the value of a public static readonly field in your class. That identifier is then used to reference the dependency property later, for operations such as setting its value programmatically or obtaining metadata.

Register(String, Type, Type, PropertyMetadata)

Registers a dependency property with the specified property name, property type, owner type, and property metadata.

Declaration

public static DependencyProperty Register(string name, Type propertyType, Type ownerType, PropertyMetadata typeMetadata)

Parameters

System.String name The name of the dependency property to register.

System.Type propertyType The type of the property.

System.Type ownerType The owner type that is registering the dependency property.

PropertyMetadata typeMetadata Property metadata for the dependency property.

Returns

System.Windows.DependencyProperty A dependency property identifier that should be used to set the value of a public static readonly field in your class. That identifier is then used to reference the dependency property later, for operations such as setting its value programmatically or obtaining metadata.

Register(String, Type, Type, PropertyMetadata, ValidateValueCallback)

Registers a dependency property with the specified property name, property type, owner type, property metadata and validate value callback.

Declaration

public static DependencyProperty Register(string name, Type propertyType, Type ownerType, PropertyMetadata typeMetadata, ValidateValueCallback validateValueCallback)

Parameters

System.String name The name of the dependency property to register.

System.Type propertyType The type of the property.

System.Type ownerType The owner type that is registering the dependency property.

PropertyMetadata typeMetadata Property metadata for the dependency property.

ValidateValueCallback validateValueCallback Callback that validates the new value for the dependency property.

Returns

System.Windows.DependencyProperty A dependency property identifier that should be used to set the value of a public static readonly field in your class. That identifier is then used to reference the dependency property later, for operations such as setting its value programmatically or obtaining metadata.

RegisterAttached(String, Type, Type)

Registers an attached property with the specified property name, property type, owner type, and property metadata.

Declaration

public static DependencyProperty RegisterAttached(string name, Type propertyType, Type ownerType)

Parameters

System.String name The name of the dependency property to register.

System.Type propertyType The type of the property.

System.Type ownerType The owner type that is registering the dependency property.

Returns

System.Windows.DependencyProperty A dependency property identifier that should be used to set the value of a public static readonly field in your class. That identifier is then used to reference the dependency property later, for operations such as setting its value programmatically or obtaining metadata.

RegisterAttached(String, Type, Type, PropertyMetadata)

Registers an attached property with the specified property name, property type, owner type, and property metadata.

Declaration

public static DependencyProperty RegisterAttached(string name, Type propertyType, Type ownerType, PropertyMetadata typeMetadata)

Parameters

System.String name The name of the dependency property to register.

System.Type propertyType The type of the property.

System.Type ownerType The owner type that is registering the dependency property.

PropertyMetadata typeMetadata Property metadata for the dependency property.

Returns

System.Windows.DependencyProperty A dependency property identifier that should be used to set the value of a public static readonly field in your class. That identifier is then used to reference the dependency property later, for operations such as setting its value programmatically or obtaining metadata.

RegisterAttached(String, Type, Type, PropertyMetadata, ValidateValueCallback)

Registers an attached property with the specified property name, property type, owner type, and property metadata.

Declaration

public static DependencyProperty RegisterAttached(string name, Type propertyType, Type ownerType, PropertyMetadata typeMetadata, ValidateValueCallback validateValueCallback)

Parameters

System.String name The name of the dependency property to register.

System.Type propertyType The type of the property.

System.Type ownerType The owner type that is registering the dependency property.

PropertyMetadata typeMetadata Property metadata for the dependency property.

ValidateValueCallback validateValueCallback Callback that validates the new value for the dependency property.

Returns

System.Windows.DependencyProperty A dependency property identifier that should be used to set the value of a public static readonly field in your class. That identifier is then used to reference the dependency property later, for operations such as setting its value programmatically or obtaining metadata.

RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata)

Registers a read-only attached property with the specified property name, property type, owner type, and property metadata.

Declaration

public static DependencyPropertyKey RegisterAttachedReadOnly(string name, Type propertyType, Type ownerType, PropertyMetadata typeMetadata)

Parameters

System.String name The name of the dependency property to register.

System.Type propertyType The type of the property.

System.Type ownerType The owner type that is registering the dependency property.

PropertyMetadata typeMetadata Property metadata for the dependency property.

Returns

DependencyPropertyKey A dependency property identifier that should be used to set the value of a public static readonly field in your class. That identifier is then used to reference the dependency property later, for operations such as setting its value programmatically or obtaining metadata.

RegisterAttachedReadOnly(String, Type, Type, PropertyMetadata, ValidateValueCallback)

Registers a read-only attached property with the specified property name, property type, owner type, and property metadata.

Declaration

public static DependencyPropertyKey RegisterAttachedReadOnly(string name, Type propertyType, Type ownerType, PropertyMetadata typeMetadata, ValidateValueCallback validateValueCallback)

Parameters

System.String name The name of the dependency property to register.

System.Type propertyType The type of the property.

System.Type ownerType The owner type that is registering the dependency property.

PropertyMetadata typeMetadata Property metadata for the dependency property.

ValidateValueCallback validateValueCallback Callback that validates the new value for the dependency property.

Returns

DependencyPropertyKey A dependency property identifier that should be used to set the value of a public static readonly field in your class. That identifier is then used to reference the dependency property later, for operations such as setting its value programmatically or obtaining metadata.

RegisterReadOnly(String, Type, Type, PropertyMetadata)

Registers a read-only dependency property with the specified property name, property type, owner type, and property metadata.

Declaration

public static DependencyPropertyKey RegisterReadOnly(string name, Type propertyType, Type ownerType, PropertyMetadata typeMetadata)

Parameters

System.String name The name of the dependency property to register.

System.Type propertyType The type of the property.

System.Type ownerType The owner type that is registering the dependency property.

PropertyMetadata typeMetadata Property metadata for the dependency property.

Returns

DependencyPropertyKey A dependency property identifier that should be used to set the value of a public static readonly field in your class. That identifier is then used to reference the dependency property later, for operations such as setting its value programmatically or obtaining metadata.

RegisterReadOnly(String, Type, Type, PropertyMetadata, ValidateValueCallback)

Registers a read-only dependency property with the specified property name, property type, owner type, and property metadata.

Declaration

public static DependencyPropertyKey RegisterReadOnly(string name, Type propertyType, Type ownerType, PropertyMetadata typeMetadata, ValidateValueCallback validateValueCallback)

Parameters

System.String name The name of the dependency property to register.

System.Type propertyType The type of the property.

System.Type ownerType The owner type that is registering the dependency property.

PropertyMetadata typeMetadata Property metadata for the dependency property.

ValidateValueCallback validateValueCallback Callback that validates the new value for the dependency property.

Returns

DependencyPropertyKey A dependency property identifier that should be used to set the value of a public static readonly field in your class. That identifier is then used to reference the dependency property later, for operations such as setting its value programmatically or obtaining metadata.

SetValue(DependencyObject, DependencyPropertyKey, Object)

Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.

Declaration

public static void SetValue(this DependencyObject element, DependencyPropertyKey key, object value)

Parameters

System.Windows.DependencyObject element The element to set the value to.

DependencyPropertyKey key The DependencyPropertyKey identifier of the property to set.

System.Object value The new local value.