Share via


AdornmentLayerDefinition Class

Provides information for an IAdornmentLayer export.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.Text.Editor.AdornmentLayerDefinition

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

Syntax

'Declaration
Public NotInheritable Class AdornmentLayerDefinition
public sealed class AdornmentLayerDefinition
public ref class AdornmentLayerDefinition sealed
[<Sealed>]
type AdornmentLayerDefinition =  class end
public final class AdornmentLayerDefinition

The AdornmentLayerDefinition type exposes the following members.

Constructors

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

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

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.

Examples

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 ExtensionWalkthrough: 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

Reference

Microsoft.VisualStudio.Text.Editor Namespace