IAdornmentLayer Interface
TOC
Collapse the table of content
Expand the table of content

IAdornmentLayer Interface

 

Represents an adornment layer.

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

public interface IAdornmentLayer

NameDescription
System_CAPS_pubpropertyElements

Gets a collection of the adornments and their associated data in the layer.

System_CAPS_pubpropertyIsEmpty

Determines whether this layer is empty, that is, it does not contain any adornments.

System_CAPS_pubpropertyOpacity

Gets or sets the opacity factor applied to the entire adornment layer when it is rendered in the user interface.

System_CAPS_pubpropertyTextView

Gets the IWpfTextView to which this layer is attached.

NameDescription
System_CAPS_pubmethodAddAdornment(AdornmentPositioningBehavior, Nullable<SnapshotSpan>, Object, UIElement, AdornmentRemovedCallback)

Adds a UIElement to the layer.

System_CAPS_pubmethodAddAdornment(SnapshotSpan, Object, UIElement)

Adds a UIElement that is TextRelative to the layer.

System_CAPS_pubmethodRemoveAdornment(UIElement)

Removes a specific UIElement.

System_CAPS_pubmethodRemoveAdornmentsByTag(Object)

Removes all UIElement objects associated with a particular tag.

System_CAPS_pubmethodRemoveAdornmentsByVisualSpan(SnapshotSpan)

Removes all adornments with visual spans that overlap the given visual span.

System_CAPS_pubmethodRemoveAllAdornments()

Removes all UIElement objects in the layer.

System_CAPS_pubmethodRemoveMatchingAdornments(Predicate<IAdornmentLayerElement>)

Removes all matching adornments.

System_CAPS_pubmethodRemoveMatchingAdornments(SnapshotSpan, Predicate<IAdornmentLayerElement>)

Removes all matching adornments with visual spans \.

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

Return to top
Show:
© 2016 Microsoft