TextBounds Structure

 

The bounds of a span of text in a given text line.

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

public struct TextBounds

NameDescription
System_CAPS_pubmethodTextBounds(Double, Double, Double, Double, Double, Double)

Initializes a new instance of TextBounds.

NameDescription
System_CAPS_pubpropertyBottom

Gets the position of the bottom edge of the rectangle in the text rendering coordinate system.

System_CAPS_pubpropertyHeight

Gets the distance between the top and bottom edges of the rectangle in the text rendering coordinate system.

System_CAPS_pubpropertyIsRightToLeft

Determines whether the character is a right-to-left character.

System_CAPS_pubpropertyLeading

Gets the position of the leading edge of the rectangle in the text rendering coordinate system.

System_CAPS_pubpropertyLeft

Gets the position of the left edge of the rectangle in the text rendering coordinate system.

System_CAPS_pubpropertyRight

Gets the position of the right edge of the rectangle in the text rendering coordinate system.

System_CAPS_pubpropertyTextBottom

Gets the bottom of the text on the line containing the characters.

System_CAPS_pubpropertyTextHeight

Gets the height of the text on the line containing the characters.

System_CAPS_pubpropertyTextTop

Gets the top of the text on the line containing the text.

System_CAPS_pubpropertyTop

Gets the position of the top edge of the rectangle in the text rendering coordinate system.

System_CAPS_pubpropertyTrailing

Gets the position of the trailing edge of the rectangle in the text rendering coordinate system.

System_CAPS_pubpropertyWidth

Gets the distance between the leading and trailing edges of the rectangle in the text rendering coordinate system.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether two TextBounds objects are the same.(Overrides ValueType.Equals(Object).)

System_CAPS_pubmethodGetHashCode()

Gets the hash code of the TextBounds object.(Overrides ValueType.GetHashCode().)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

Converts the TextBounds object to a string.(Overrides ValueType.ToString().)

NameDescription
System_CAPS_puboperatorSystem_CAPS_staticEquality(TextBounds, TextBounds)

Determines whether two TextBounds objects are the same.

System_CAPS_puboperatorSystem_CAPS_staticInequality(TextBounds, TextBounds)

Determines whether two TextBounds objects are different.

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: