IAdornmentLayer::AddAdornment Method (AdornmentPositioningBehavior, Nullable<SnapshotSpan>, Object^, UIElement^, AdornmentRemovedCallback^)
Visual Studio 2015
Adds a UIElement to the layer.
Assembly: Microsoft.VisualStudio.Text.UI.Wpf (in Microsoft.VisualStudio.Text.UI.Wpf.dll)
bool AddAdornment(
AdornmentPositioningBehavior behavior,
Nullable<SnapshotSpan> visualSpan,
Object^ tag,
UIElement^ adornment,
AdornmentRemovedCallback^ removedCallback
)
Parameters
- behavior
-
Type:
Microsoft.VisualStudio.Text.Editor::AdornmentPositioningBehavior
The positioning behavior of adornment.
- visualSpan
-
Type:
System::Nullable<SnapshotSpan>
The span with which adornment is associated.
- tag
-
Type:
System::Object^
The tag associated with adornment.
- adornment
-
Type:
System.Windows::UIElement^
The UIElement to add to the view.
- removedCallback
-
Type:
Microsoft.VisualStudio.Text.Editor::AdornmentRemovedCallback^
The delegate to call when adornment is removed from the view.
Return Value
Type: System::Booleantrue if adornment was added to the layer, otherwise false.
visualSpan does not intersect the text that is visible in the view.
If visualSpan is specified, then the adornment will be removed whenever any line that crosses visualSpan is formatted. If visualSpan has a length of zero, then it will be invalidated when the line that contains the following character is invalidated (or the last line, if the visual span is at the end of the buffer).
Show: