Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Specifies that a property or type should be treated as ambient. The ambient concept relates to how XAML processors determine type owners of members.
public ref class AmbientAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Property, Inherited=true)] public sealed class AmbientAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method | System.AttributeTargets.Property, Inherited=true)] public sealed class AmbientAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Property, Inherited=true)>] type AmbientAttribute = class inherit Attribute
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method | System.AttributeTargets.Property, Inherited=true)>] type AmbientAttribute = class inherit Attribute
Public NotInheritable Class AmbientAttribute Inherits Attribute
An ambient property is a property where the value is expected to be available in the parser context when creating an object graph, but where typical type-member lookup is suspended for purposes of the immediate XAML node set being created. There are two main scenarios for the ambient concept:
Some other property of the same object influences and qualifies how that object-property lookup should work.
The property represents a larger deferral mechanism and the ambient capabilities for looking up a member value extend to all objects contained within the current object.
This attribute can be applied to specific properties that have expected containers that enable an ambient property lookup behavior, or can be applied to a class to enable the ambient property behavior in all cases of that value type for a property.
AmbientAttribute can also be applied to a CLR method, to support attributing a XAML attachable property as ambient. This is potentially necessary because in a CLR implementation a XAML attached property is implemented/represented to reflection as an accessor pattern with
set methods. No actual CLR property to attribute exists, so restricting usage for AttributeTargets to
Property would not have enabled specifying an attachable member as ambient. For an attachable member that you want to report as ambient, attribute the
get accessor. You should not attempt to attribute methods that are not specifically support methods of attachable members.
In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, AmbientAttribute is in the System.Xaml assembly. For more information, see Types Migrated from WPF to System.Xaml.
Ambient types (types where AmbientAttribute is applied at type level) can be used for certain XAML processing situations where the type of a property needs to be resolved out of order.
Object Writer Scenarios
If you are defining a XAML object writer, and you encounter a property, method or type where AmbientAttribute is applied, you typically must access a service to determine the intended ambient property lookup behavior that is needed for writing out objects. For more information, see IAmbientProvider.
Type converters or markup extensions might need to know the ambient information in order to process properties that represent indirect type mappings, such as properties that specify members or types by string names with or without qualification. In this scenario, AmbientAttribute is not intended to be used directly for value converter code logic. Rather, the value converter should rely on the XAML writer processing behavior, which will pass IAmbientProvider in its service contexts to your value converter methods when called.
WPF Scenarios for AmbientAttribute
All content within a
Resourcesproperty (items of a ResourceDictionary) as well as template content, should be able to access other peers as values. Declaring the entire
Resourcesproperty as ambient invokes logic that enables this in the WPF XAML parser.
Initializes a new instance of the AmbientAttribute class.
When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute)
Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute)
Returns the hash code for this instance.(Inherited from Attribute)
Gets the Type of the current instance.(Inherited from Object)
When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute)
When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute)
Creates a shallow copy of the current Object.(Inherited from Object)
Returns a string that represents the current object.(Inherited from Object)
Explicit Interface Implementations
|_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)||
Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute)
|_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)||
Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute)
Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute)
|_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)||
Provides access to properties and methods exposed by an object.(Inherited from Attribute)