IAdornmentLayer Interface

Represents an adornment layer.

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

Syntax

'Declaration
Public Interface IAdornmentLayer

public interface IAdornmentLayer

public interface class IAdornmentLayer

type IAdornmentLayer =  interface end

public interface IAdornmentLayer

The IAdornmentLayer type exposes the following members.

Properties

	Name	Description
	Elements	Gets a collection of the adornments and their associated data in the layer.
	IsEmpty	Determines whether this layer is empty, that is, it does not contain any adornments.
	Opacity	Gets or sets the opacity factor applied to the entire adornment layer when it is rendered in the user interface.
	TextView	Gets the IWpfTextView to which this layer is attached.

Top

Methods

	Name	Description
	AddAdornment(SnapshotSpan, Object, UIElement)	Adds a UIElement that is TextRelative to the layer.
	AddAdornment(AdornmentPositioningBehavior, Nullable<SnapshotSpan>, Object, UIElement, AdornmentRemovedCallback)	Adds a UIElement to the layer.
	RemoveAdornment	Removes a specific UIElement.
	RemoveAdornmentsByTag	Removes all UIElement objects associated with a particular tag.
	RemoveAdornmentsByVisualSpan	Removes all adornments with visual spans that overlap the given visual span.
	RemoveAllAdornments	Removes all UIElement objects in the layer.
	RemoveMatchingAdornments(Predicate<IAdornmentLayerElement>)	Removes all matching adornments.
	RemoveMatchingAdornments(SnapshotSpan, Predicate<IAdornmentLayerElement>)	Removes all matching adornments with visual spans \.

Top

Remarks

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

See Also

Reference

Microsoft.VisualStudio.Text.Editor Namespace