IWpfTextViewLineCollection.GetLineMarkerGeometry Method

Definition

Namespace:

Microsoft.VisualStudio.Text.Editor

Assembly:

Microsoft.VisualStudio.Text.UI.Wpf.dll

Package:

Microsoft.VisualStudio.Text.UI.Wpf v17.12.215

Overloads

GetLineMarkerGeometry(SnapshotSpan)	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.
GetLineMarkerGeometry(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.

GetLineMarkerGeometry(SnapshotSpan)

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.

public:
 System::Windows::Media::Geometry ^ GetLineMarkerGeometry(Microsoft::VisualStudio::Text::SnapshotSpan bufferSpan);

public System.Windows.Media.Geometry GetLineMarkerGeometry (Microsoft.VisualStudio.Text.SnapshotSpan bufferSpan);

abstract member GetLineMarkerGeometry : Microsoft.VisualStudio.Text.SnapshotSpan -> System.Windows.Media.Geometry

Public Function GetLineMarkerGeometry (bufferSpan As SnapshotSpan) As Geometry

Parameters

bufferSpan

SnapshotSpan

The span of text.

Returns

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.

Exceptions

ArgumentOutOfRangeException

bufferSpan is not a valid SnapshotSpan on the buffer.

Remarks

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.

The returned geometry is not clipped to the boundaries of the viewport.

GetLineMarkerGeometry(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.

public:
 System::Windows::Media::Geometry ^ GetLineMarkerGeometry(Microsoft::VisualStudio::Text::SnapshotSpan bufferSpan, bool clipToViewport, System::Windows::Thickness padding);

public System.Windows.Media.Geometry GetLineMarkerGeometry (Microsoft.VisualStudio.Text.SnapshotSpan bufferSpan, bool clipToViewport, System.Windows.Thickness padding);

abstract member GetLineMarkerGeometry : Microsoft.VisualStudio.Text.SnapshotSpan * bool * System.Windows.Thickness -> System.Windows.Media.Geometry

Public Function GetLineMarkerGeometry (bufferSpan As SnapshotSpan, clipToViewport As Boolean, padding As Thickness) As Geometry

Parameters

bufferSpan

SnapshotSpan

The span of text.

clipToViewport

Boolean

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

padding

Thickness

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

Returns

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.

Exceptions

ArgumentOutOfRangeException

bufferSpan is not a valid SnapshotSpan on the buffer.

Remarks

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.