TextBounds Struct

public struct TextBounds

public TextBounds(Rectangle bounds, bool isRightToLeft)

Parameter	Type	Description
bounds	Rectangle	A Rect that specifies the bounds.
isRightToLeft	bool	Whether the text is right-to-left.

public TextBounds(int x, int y, int width, int height, bool isRightToLeft)

Parameter	Type	Description
x	int	Gets the x-axis position of the left side of the bounds.
y	int	Gets the y-axis position of the top of the bounds.
width	int	Gets the width of the bounds.
height	int	Gets the height of the bounds.
isRightToLeft	bool	Whether the text is right-to-left.

public int Bottom { get; }

Property Value

int:

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

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.

public int Height { get; }

Property Value

int:

The height of the bounds.

public bool IsEmpty { get; }

Property Value

bool:

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

public bool IsLeftToRight { get; }

Property Value

bool:

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

public bool IsRightToLeft { get; }

Property Value

bool:

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

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.

public int Left { get; }

Property Value

int:

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

public Rectangle Rect { get; }

Property Value

Rectangle:

A Rect that specifies the bounds.

public int Right { get; }

Property Value

int:

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

public int Top { get; }

Property Value

int:

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

public int Width { get; }

Property Value

int:

The width of the bounds.

public int X { get; }

Property Value

int:

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

public int Y { get; }

Property Value

int:

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

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.

public override int GetHashCode()

Returns

int:

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

public override string ToString()

Returns

string:

A string whose value represents this object.

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.

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.