IWpfTextViewLineCollection::GetLineMarkerGeometry Method (SnapshotSpan, Boolean, Thickness)

 

Gets the text marker geometry for the specified range of text in the buffer by using a polygonal approximation algorithm to calculate the outline path of the text regions.

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

Geometry^ GetLineMarkerGeometry(
	SnapshotSpan bufferSpan,
	bool clipToViewport,
	Thickness padding
)

Parameters

bufferSpan
Type: Microsoft.VisualStudio.Text::SnapshotSpan

The span of text.

clipToViewport
Type: System::Boolean

If true, the created geometry will be clipped to the viewport.

padding
Type: System.Windows::Thickness

A padding that's applied to the elements on a per line basis.

Return Value

Type: System.Windows.Media::Geometry^

A Geometry that contains the bounds of all of the formatted text in the span. It is null if the span is empty or does not intersect the text formatted in the ITextView.

Exception Condition
ArgumentOutOfRangeException

bufferSpan is not a valid SnapshotSpan o the buffer.

The returned geometry may contain several disjoint regions if the span contains a mix of conventional and bi-directional text. This method uses the height of the rendered line (Height) to calculate the height of the geometry on each line.

Return to top
Show: