IAdornmentLayer::AddAdornment Method (SnapshotSpan, Object^, UIElement^)

Visual Studio 2015
 

Adds a UIElement that is TextRelative to the layer.

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

C#
C++
F#
VB
Copy 
bool AddAdornment(
	SnapshotSpan visualSpan,
	Object^ tag,
	UIElement^ adornment
)

Parameters

visualSpan
Type: Microsoft.VisualStudio.Text::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.

Return Value

Type: System::Boolean

true if adornment was added to the layer, otherwise false. visualSpan does not intersect the text that is visible in the view.

The adornment is removed when 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 visualSpan is at the end of the buffer).

Return to top
Show: