This documentation is archived and is not being maintained.

DependsOnAttribute Class

Indicates that the attributed property is dependent on the value of another property.


Namespace:  System.Windows.Markup
Assembly:  System.Xaml (in System.Xaml.dll)
XMLNS for XAML: Not mapped to an xmlns.

[AttributeUsageAttribute(AttributeTargets.Method|AttributeTargets.Property, AllowMultiple = true)]
public sealed class DependsOnAttribute : Attribute

The DependsOnAttribute type exposes the following members.

Public methodDependsOnAttributeInitializes a new instance of the DependsOnAttribute class.

Public propertyNameGets the name of the related property declared in this DependsOnAttribute.
Public propertyTypeIdGets a unique identifier for this DependsOnAttribute. (Overrides Attribute.TypeId.)

Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)

The Save method on XamlWriter will process the specified property before processing the property that this attribute is set on.

The name value applied to this attribute must be the simple unqualified name of a property that exists in the same type. You cannot specify attached properties as being dependent.

When applying this attribute, care must be taken to avoid circular dependencies. Circular dependencies are only detected when all the properties in the cycle have been written and even so the behavior is nondeterministic.

Applying this attribute to a property definition ensures that the dependent properties are processed first in XAML object writing. It is part of the general rules of XAML markup that attribute values applied for a created object should be able to be processed in any order. Usages of DependsOnAttribute specify the exceptional cases of properties on types where a specific order of parsing must be followed for valid object creation.

In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework version 4, DependsOnAttribute is in the System.Xaml assembly. For more information, see Types Migrated from WPF to System.Xaml.

WPF Usage Notes

The Value property on the Setter class is an example of a property in WPF where the DependsOnAttribute attribute is applied. Value depends on Property and TargetName being processed first, otherwise there is no way to know what type is supposed to be created for value converter cases.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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