This documentation is archived and is not being maintained.

AdornmentLayerDefinition Class

Provides information for an IAdornmentLayer export.


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

public sealed class AdornmentLayerDefinition

The AdornmentLayerDefinition type exposes the following members.

Public methodAdornmentLayerDefinitionInitializes a new instance of AdornmentLayerDefinition.

Public methodEqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
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 methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns 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.

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