AdornmentLayerDefinition Class

Provides information for an IAdornmentLayer export.

Inheritance Hierarchy


Namespace:  Microsoft.VisualStudio.Text.Editor
Assembly:  Microsoft.VisualStudio.Text.UI.Wpf (in Microsoft.VisualStudio.Text.UI.Wpf.dll)


Public NotInheritable Class AdornmentLayerDefinition
public sealed class AdornmentLayerDefinition
public ref class AdornmentLayerDefinition sealed
type AdornmentLayerDefinition =  class end
public final class AdornmentLayerDefinition

The AdornmentLayerDefinition type exposes the following members.


  Name Description
Public method AdornmentLayerDefinition Initializes a new instance of AdornmentLayerDefinition.



  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)



Because you cannot subclass this type, you can use the [Export] attribute with no type.

For an explanation of adornments, see the "Extending Adornments" section of Editor Extension Points and the "Adornments" section of Inside the Editor.


For an example of how to use this class, see the "Defining an Adornment Layer" section of Walkthrough: Using a Shell Command with an Editor Extension Walkthrough: Using a Shell Command with an Editor Extension.

Thread Safety

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

See Also


Microsoft.VisualStudio.Text.Editor Namespace