DependencyProperty.Register Method (System.Windows)

MSDN Library
Web Development
Silverlight
Silverlight 3
.NET Framework Class Library for Silverlight
System.Windows Namespace
DependencyProperty Class
DependencyProperty Methods

GetMetadata Method

RegisterAttached Method

Related Links

Analytics Class
Application Class
ApplicationServiceContext Class
ApplicationUnhandledExceptionEventArgs Class
AssemblyPart Class
AssemblyPartCollection Class
CheckAndDownloadUpdateCompletedEventArgs Class
CheckAndDownloadUpdateCompletedEventHandler Delegate
CornerRadius Structure
CrossDomainAccess Enumeration
DataTemplate Class
DependencyObject Class
DependencyProperty Class
DependencyPropertyChangedEventArgs Structure
DependencyPropertyChangedEventHandler Delegate
Deployment Class
Duration Structure
DurationConverter Class
EventTrigger Class
ExceptionRoutedEventArgs Class
ExceptionRoutedEventHandler Delegate
Expression Class
ExtensionPart Class
ExternalPart Class
ExternalPartCollection Class
FontStretch Structure
FontStretches Class
FontStyle Structure
FontStyles Class
FontWeight Structure
FontWeights Class
FrameworkElement Class
FrameworkTemplate Class
GpuInformation Class
GridLength Structure
GridUnitType Enumeration
HierarchicalDataTemplate Class
HorizontalAlignment Enumeration
IApplicationLifetimeAware Interface
IApplicationService Interface
Icon Class
IconCollection Class
InstallState Enumeration
LineStackingStrategy Enumeration
MessageBox Class
MessageBoxButton Enumeration
MessageBoxResult Enumeration
NullableBoolConverter Class
OutOfBrowserSettings Class
Point Structure
PresentationFrameworkCollection(T) Class
PropertyChangedCallback Delegate
PropertyMetadata Class
PropertyPath Class
PropertyPathConverter Class
Rect Structure
ResourceDictionary Class
RoutedEvent Class
RoutedEventArgs Class
RoutedEventHandler Delegate
RoutedPropertyChangedEventArgs(T) Class
RoutedPropertyChangedEventHandler(T) Delegate
Setter Class
SetterBase Class
SetterBaseCollection Class
Size Structure
SizeChangedEventArgs Class
SizeChangedEventHandler Delegate
StartupEventArgs Class
StartupEventHandler Delegate
Style Class
StyleTypedPropertyAttribute Class
SystemColors Class
SystemParameters Class
TemplateBindingExpression Class
TemplatePartAttribute Class
TemplateVisualStateAttribute Class
TextAlignment Enumeration
TextDecorationCollection Class
TextDecorations Class
TextWrapping Enumeration
Thickness Structure
TriggerAction Class
TriggerActionCollection Class
TriggerBase Class
TriggerCollection Class
UIElement Class
VerticalAlignment Enumeration
Visibility Enumeration
VisualState Class
VisualStateChangedEventArgs Class
VisualStateGroup Class
VisualStateManager Class
VisualTransition Class
WindowSettings Class

DependencyProperty..::.Register Method
This page is specific to:Microsoft Version:3.0 3.5Silverlight 34.0

.NET Framework Class Library for Silverlight

DependencyProperty..::.Register Method

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

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

Syntax

C++

JScript

Copy to Clipboard Print

'Usage

Dim name As String
Dim propertyType As Type
Dim ownerType As Type
Dim typeMetadata As PropertyMetadata
Dim returnValue As DependencyProperty

returnValue = DependencyProperty.Register(name, _
    propertyType, ownerType, typeMetadata)

'Declaration

Public Shared Function Register ( _
    name As String, _
    propertyType As Type, _
    ownerType As Type, _
    typeMetadata As PropertyMetadata _
) As DependencyProperty

Parameters

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

propertyType: Type: System..::.Type
The type of the property.

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

typeMetadata: Type: System.Windows..::.PropertyMetadata
A property metadata instance. This can contain a PropertyChangedCallback implementation reference.

Return Value

Type: System.Windows..::.DependencyProperty
A dependency property identifier that should be used to set the value of a public static readonly field in your class. The identifier is then used both by your own code and any third-party user code to reference the dependency property later, for operations such as setting its value programmatically, or attaching a Binding in code.

Exceptions

Exception	Condition
ArgumentNullException	A required parameter was nullNothingnullptra null reference (Nothing in Visual Basic) (check the exception for the name of the missing parameter).
ArgumentException	A parameter was out of range, for instance name was an empty string. -or- Attempted to register with a propertyType that does not match a default value specified in the typeMetadata.

Exception

Condition

ArgumentNullException

A required parameter was nullNothingnullptra null reference (Nothing in Visual Basic) (check the exception for the name of the missing parameter).

ArgumentException

A parameter was out of range, for instance name was an empty string.

-or-

Attempted to register with a propertyType that does not match a default value specified in the typeMetadata.

Remarks

Dependency property concepts are covered in detail in the topic Dependency Properties Overview.

For more information on using Register to register a custom dependency property, including examples and procedures, see Custom Dependency Objects and Dependency Properties.

If you do not need property metadata for your dependency property, specify typeMetadata as nullNothingnullptra null reference (Nothing in Visual Basic).

Silverlight does not support custom read-only dependency properties. For details, see Dependency Properties Overview.

Important Note:
Do not register a dependency property with the specific default value of UnsetValue. This will be confusing for property consumers and will have unintended consequences within the property system.

Examples

The following example shows a basic usage where a DependencyProperty is established as a public static member of a class. This is done by calling Register and storing the return value.

C++

JScript

Copy to Clipboard Print

Public Shared ReadOnly IsSpinningProperty As DependencyProperty = _
    DependencyProperty.Register("IsSpinning", _
    GetType(Boolean), _
    GetType(SilverlightExampleClass), _
    Nothing)
Public Property IsSpinning() As Boolean
    Get
        Return CBool(GetValue(IsSpinningProperty))
    End Get
    Set(ByVal value As Boolean)
        SetValue(IsSpinningProperty, value)
    End Set
End Property

You can find a similar example that provides more information about creating a custom dependency property in the topic Custom Dependency Objects and Dependency Properties.

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Reference

DependencyProperty Class

DependencyProperty Members

System.Windows Namespace

Other Resources

Dependency Properties Overview