LineTransform Struct

Definition

Namespace:

Microsoft.VisualStudio.Text.Formatting

Assembly:

Microsoft.VisualStudio.Text.UI.dll

Package:

Microsoft.VisualStudio.Text.UI v17.11.260

Represents the transform from a formatted text line to a rendered text line.

public value class LineTransform

public value class LineTransform

struct LineTransform

public struct LineTransform

type LineTransform = struct

Public Structure LineTransform

Inheritance

ValueType

LineTransform

Remarks

Most properties and parameters that are doubles correspond to coordinates or distances in the text rendering coordinate system. In this coordinate system, x = 0.0 corresponds to the left edge of the drawing surface onto which text is rendered (x = view.ViewportLeft corresponds to the left edge of the viewport), and y = view.ViewportTop corresponds to the top edge of the viewport. The x-coordinate increases from left to right, and the y-coordinate increases from top to bottom.

The horizontal and vertical axes of the view behave differently. When the text in the view is formatted, only the visible lines are formatted. As a result, a viewport cannot be scrolled horizontally and vertically in the same way.

A viewport is scrolled horizontally by changing the left coordinate of the viewport so that it moves with respect to the drawing surface.

A view can be scrolled vertically only by performing a new layout.

Doing a layout in the view may cause the ViewportTop property of the view to change. For example, scrolling down one line will not translate any of the visible lines. Instead it will simply change the view's ViewportTop property (causing the lines to move on the screen even though their y-coordinates have not changed).

Distances in the text rendering coordinate system correspond to logical pixels. If the text rendering surface is displayed without any scaling transform, then 1 unit in the text rendering coordinate system corresponds to one pixel on the display.

Constructors

LineTransform(Double, Double, Double, Double)	Initializes a new instance of a LineTransform.
LineTransform(Double, Double, Double)	Initializes a new instance of a LineTransform.
LineTransform(Double)	Initializes a new instance of a LineTransform.

Properties

BottomSpace	Gets the amount of space required below the text of the line before applying the VerticalScale factor.
Right	Gets the x-coordinate of the effective right edge of the line.
TopSpace	Gets the amount of space required above the text of the line before applying the VerticalScale factor.
VerticalScale	Gets the vertical scale factor to be applied to the text of the line. The scale factor does not affect and the space above and below the line.

Methods

Combine(LineTransform, LineTransform)	Combines two LineTransform objects.
Equals(Object)	Determines whether two LineTransform objects are the same.
GetHashCode()	Gets the hash code for this object.

Operators

Equality(LineTransform, LineTransform)	Determines whether two LineTransform objects are the same.
Inequality(LineTransform, LineTransform)	Determines whether two LineTransform objects are different.