ILineTransformSource.GetLineTransform Method

Definition

Computes the line transform for a given line of formatted text.

public:
 Microsoft::VisualStudio::Text::Formatting::LineTransform GetLineTransform(Microsoft::VisualStudio::Text::Formatting::ITextViewLine ^ line, double yPosition, Microsoft::VisualStudio::Text::Editor::ViewRelativePosition placement);
public:
 Microsoft::VisualStudio::Text::Formatting::LineTransform GetLineTransform(Microsoft::VisualStudio::Text::Formatting::ITextViewLine ^ line, double yPosition, Microsoft::VisualStudio::Text::Editor::ViewRelativePosition placement);
Microsoft::VisualStudio::Text::Formatting::LineTransform GetLineTransform(Microsoft::VisualStudio::Text::Formatting::ITextViewLine const & line, double yPosition, Microsoft::VisualStudio::Text::Editor::ViewRelativePosition placement);
public Microsoft.VisualStudio.Text.Formatting.LineTransform GetLineTransform (Microsoft.VisualStudio.Text.Formatting.ITextViewLine line, double yPosition, Microsoft.VisualStudio.Text.Editor.ViewRelativePosition placement);
abstract member GetLineTransform : Microsoft.VisualStudio.Text.Formatting.ITextViewLine * double * Microsoft.VisualStudio.Text.Editor.ViewRelativePosition -> Microsoft.VisualStudio.Text.Formatting.LineTransform
Public Function GetLineTransform (line As ITextViewLine, yPosition As Double, placement As ViewRelativePosition) As LineTransform

Parameters

line
ITextViewLine

The line for which to compute the line transform.

yPosition
Double

The y-coordinate of the line.

placement
ViewRelativePosition

The placement of the line with respect to yPosition.

Returns

The line transform for that line.

Remarks

If placement is ViewRelativePosition.Top, then the top of the line will be located at yPosition. Otherwise the bottom of the line will be located at yPosition. Also, the line transform only affects the line itself and not any space allocated above or below the line for adornments.

Applies to