In This Article

TextBounds Struct

Describes the width, height, location, and flow direction of a range of text.

public struct TextBounds

Constructors

TextBounds(double, double, double, double, bool)

Initializes a new instance of the TextBounds structure.

public TextBounds(double x, double y, double width, double height, bool isRightToLeft)
Parameter Type Description
x double

Gets the x-axis position of the left side of the bounds.

y double

Gets the y-axis position of the top of the bounds.

width double

Gets the width of the bounds.

height double

Gets the height of the bounds.

isRightToLeft bool

Whether the text is right-to-left.

TextBounds(Rect, bool)

Initializes a new instance of the TextBounds structure.

public TextBounds(Rect bounds, bool isRightToLeft)
Parameter Type Description
bounds Rect

A Rect that specifies the bounds.

isRightToLeft bool

Whether the text is right-to-left.

Properties

Bottom

Gets the y-axis value of the bottom of the bounds (Y + Height).

public double Bottom { get; }

Property Value

double:

The y-axis value of the bottom of the bounds.

Empty

Gets the empty bounds, a special value that represents a bounds with no position or area.

public static TextBounds Empty { get; }

Property Value

TextBounds:

The empty rectangle, which has X and Y values of PositiveInfinity, and has Width and Height values of NegativeInfinity.

FlowDirection

Gets the FlowDirection of the text.

public FlowDirection FlowDirection { get; }

Property Value

FlowDirection:

The FlowDirection of the text.

Height

Gets the height of the bounds.

public double Height { get; }

Property Value

double:

The height of the bounds.

IsEmpty

Gets a value that indicates whether this bounds is the Empty bounds.

public bool IsEmpty { get; }

Property Value

bool:

true if this rectangle is the Empty rectangle; otherwise, false.

IsLeftToRight

Gets whether the text is left-to-right.

public bool IsLeftToRight { get; }

Property Value

bool:

true if the text is left-to-right; otherwise, false.

IsRightToLeft

Gets whether the text is right-to-left.

public bool IsRightToLeft { get; }

Property Value

bool:

true if the text is right-to-left; otherwise, false.

IsYValid

Gets a value that indicates whether the Y property is a valid value.

public bool IsYValid { get; }

Property Value

bool:

true if the Y property is a valid value; otherwise, false.

Remarks

The Y value may be invalid when getting bounds for a text line that is not currently visible.

Left

Gets the x-axis position of the left side of the bounds. Getting this property is equivalent to getting the bounds's X property.

public double Left { get; }

Property Value

double:

The x-axis position of the left side of the bounds.

Rect

Gets a Rect that specifies the bounds.

public Rect Rect { get; }

Property Value

Rect:

A Rect that specifies the bounds.

Right

Gets the x-axis value of the right side of the bounds (X + Width).

public double Right { get; }

Property Value

double:

The x-axis value of the right side of the bounds.

Top

Gets the y-axis position of the top of the bounds. Getting this property is equivalent to getting the bounds's Y property.

public double Top { get; }

Property Value

double:

The y-axis position of the top of the bounds.

Width

Gets the width of the bounds.

public double Width { get; }

Property Value

double:

The width of the bounds.

X

Gets the x-axis position of the left side of the bounds.

public double X { get; }

Property Value

double:

The x-axis position of the left side of the bounds.

Y

Gets the y-axis position of the top of the bounds.

public double Y { get; }

Property Value

double:

The y-axis position of the top of the bounds.

Methods

Equals(object)

Determines whether the specified Object is equal to the current Object.

public override bool Equals(object obj)
Parameter Type Description
obj object

The Object to compare to the current Object.

Returns

bool:

true if the specified Object is equal to the current Object; otherwise, false.

GetHashCode()

Returns a hash code for this object.

public override int GetHashCode()

Returns

int:

An integer value that specifies a hash value for this object.

ToString()

Converts the object to a String.

public override string ToString()

Returns

string:

A string whose value represents this object.

Operators

operator ==(TextBounds, TextBounds)

Compares two TextBounds objects.

public static bool operator ==(TextBounds left, TextBounds right)
Parameter Type Description
left TextBounds

A TextBounds to compare.

right TextBounds

A TextBounds to compare.

Returns

bool:

true if the values of left and right are equal; otherwise, false.

operator !=(TextBounds, TextBounds)

Compares two TextBounds objects.

public static bool operator !=(TextBounds left, TextBounds right)
Parameter Type Description
left TextBounds

A TextBounds to compare.

right TextBounds

A TextBounds to compare.

Returns

bool:

true if the values of left and right are unequal; otherwise, false.

Inherited Members