This topic has not yet been rated - Rate this topic

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

The IAdornmentLayer type exposes the following members.

  NameDescription
Public propertyElementsGets a collection of the adornments and their associated data in the layer.
Public propertyIsEmptyDetermines whether this layer is empty, that is, it does not contain any adornments.
Public propertyOpacityGets or sets the opacity factor applied to the entire adornment layer when it is rendered in the user interface.
Public propertyTextViewGets the IWpfTextView to which this layer is attached.
Top
  NameDescription
Public methodAddAdornment(SnapshotSpan, Object, UIElement)Adds a UIElement that is TextRelative to the layer.
Public methodAddAdornment(AdornmentPositioningBehavior, Nullable<SnapshotSpan>, Object, UIElement, AdornmentRemovedCallback)Adds a UIElement to the layer.
Public methodRemoveAdornmentRemoves a specific UIElement.
Public methodRemoveAdornmentsByTagRemoves all UIElement objects associated with a particular tag.
Public methodRemoveAdornmentsByVisualSpanRemoves all adornments with visual spans that overlap the given visual span.
Public methodRemoveAllAdornmentsRemoves all UIElement objects in the layer.
Public methodRemoveMatchingAdornments(Predicate<IAdornmentLayerElement>)Removes all matching adornments.
Public methodRemoveMatchingAdornments(SnapshotSpan, Predicate<IAdornmentLayerElement>)Removes all matching adornments with visual spans \.
Top

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

Did you find this helpful?
(1500 characters remaining)

Community Additions

ADD
© 2013 Microsoft. All rights reserved.