Specifies that an attached property has a browsable scope that extends to child elements in the logical tree.
Assembly: PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
Thetype exposes the following members.
|IncludeDescendants||Gets or sets a value that declares whether to use the deep mode for detection of parent elements on the attached property where this .NET Framework attribute is applied.|
|TypeId||When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)|
|Equals||Determines whether the current .NET Framework attribute is equal to a specified object. (Overrides Attribute.Equals(Object).)|
|GetHashCode||Returns the hash code for this .NET Framework attribute. (Overrides Attribute.GetHashCode().)|
|GetType||Gets the Type of the current instance. (Inherited from Object.)|
|IsDefaultAttribute||When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)|
|Match||When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)|
|ToString||Returns a string that represents the current object. (Inherited from Object.)|
|_Attribute.GetIDsOfNames||Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)|
|_Attribute.GetTypeInfo||Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)|
|_Attribute.GetTypeInfoCount||Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)|
|_Attribute.Invoke||Provides access to properties and methods exposed by an object. (Inherited from Attribute.)|
The meaning of the term browsable as used in descriptions for this .NET Framework attribute is analogous to the descriptions given for BrowsableAttribute, but the browsable state for an attached property is particularly relevant to property information for Extensible Application Markup Language (XAML), because an attached property is primarily a XAML concept.
When this .NET Framework attribute is applied to the get accessor for an attached property, this .NET Framework attribute specifies that an attached property is browsable when the attached property owner is a parent element of other elements.
When interpreted by a designer that uses type descriptor information, the designer should add this property as a browsable property to all child elements in the logical tree, based on the parent element with this .NET Framework attribute applied.
Generally, the browsable state parallels functionality. For example, Canvas.Left is designated browsable on elements that are child elements of a Canvas, because Canvas includes code for checking any set values of Canvas.Left on child elements.
This .NET Framework attribute supports two types of tree detection modes for parent element positions: a shallow mode, and a deep mode. The shallow mode, which is the default mode for an applied .NET Framework attribute, requires that the immediate parent element be the owner type of the property in order for the attached property to be browsable. The deep mode is declared by applying the attribute with IncludeDescendants as true. The deep mode is less restrictive because it only requires that the owner type be somewhere in the ancestor direction of the logical tree., and therefore the attached property is browsable on all child elements, not just immediate child elements. The deep mode is applied for attached property usages where intervening elements in the logical tree should not be reported as the true parent element. Implicit collections (for example, the UIElementCollection that is implicit in the Children of a Panel) are not considered to be parent elements for purposes of how this .NET Framework attribute declares the tree detection mode.
This .NET Framework attribute should only be applied on the get accessor of attached property definitions. Do not apply this .NET Framework attribute to the set accessor. Although intuitively it is the set operation that is being made browsable for XAML on child elements, it is the presence and characteristics of the get accessor on the parent element that controls the true behavior.
Whether an attached property is browsable on a child element is not an absolute guarantee that the attached property value is really processed by the parent element in some manner. Also, the IncludeDescendants value is not an absolute guarantee that the processing scope does or does not extend beyond the immediate parent element. All this is implementation specific. However, this .NET Framework attribute for reporting the browsable state is the best available mechanism for reporting the usage information and functional information for an attached property. Therefore, you can generally assume that the browsable state of an attached property is analogous to the behavior of how an attached property value on a child element is processed or interpreted by the relevant parent element in your application code.
For general information on declaring attached properties, see Attached Properties Overview.