Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
OFT.Rendering.Tools.RenderStringFormat Class Reference

Encapsulates text layout information (such as alignment, orientation and tab stops) display manipulations (such as ellipsis insertion and national digit substitution) and OpenType features. This class cannot be inherited. More...

Inheritance diagram for OFT.Rendering.Tools.RenderStringFormat:
[legend]
Collaboration diagram for OFT.Rendering.Tools.RenderStringFormat:
[legend]

Public Member Functions

override string ToString ()
 Converts this T:OFT.Rendering.StringFormat object to a human-readable string.
 
bool Equals (RenderStringFormat? other)
 
RenderStringFormat Clone ()
 
override bool Equals (object? obj)
 
override int GetHashCode ()
 

Properties

StringAlignment Alignment = StringAlignment.Near [get, set]
 Gets or sets text alignment information on the vertical plane.
 
StringFormatFlags FormatFlags = 0 [get, set]
 Gets or sets a T:OFT.Rendering.RenderStringFormatFlags enumeration that contains formatting information.
 
StringAlignment LineAlignment = StringAlignment.Near [get, set]
 Gets or sets the line alignment on the horizontal plane.
 
StringTrimming Trimming = StringTrimming.Character [get, set]
 Gets or sets the T:OFT.Rendering.RenderStringTrimming enumeration for this T:OFT.Rendering.StringFormat object.
 

Detailed Description

Encapsulates text layout information (such as alignment, orientation and tab stops) display manipulations (such as ellipsis insertion and national digit substitution) and OpenType features. This class cannot be inherited.

<filterpriority>1</filterpriority>

Member Function Documentation

◆ Clone()

RenderStringFormat OFT.Rendering.Tools.RenderStringFormat.Clone ( )

◆ Equals() [1/2]

override bool OFT.Rendering.Tools.RenderStringFormat.Equals ( object?  obj)

◆ Equals() [2/2]

bool OFT.Rendering.Tools.RenderStringFormat.Equals ( RenderStringFormat?  other)

◆ GetHashCode()

override int OFT.Rendering.Tools.RenderStringFormat.GetHashCode ( )

◆ ToString()

override string OFT.Rendering.Tools.RenderStringFormat.ToString ( )

Converts this T:OFT.Rendering.StringFormat object to a human-readable string.

Returns
A string representation of this T:OFT.Rendering.StringFormat object.

<filterpriority>1</filterpriority>

Property Documentation

◆ Alignment

StringAlignment OFT.Rendering.Tools.RenderStringFormat.Alignment = StringAlignment.Near
getset

Gets or sets text alignment information on the vertical plane.

Returns
A T:OFT.Rendering.RenderStringAlignment enumeration that specifies text alignment information.

<filterpriority>1</filterpriority>

◆ FormatFlags

StringFormatFlags OFT.Rendering.Tools.RenderStringFormat.FormatFlags = 0
getset

Gets or sets a T:OFT.Rendering.RenderStringFormatFlags enumeration that contains formatting information.

Returns
A T:OFT.Rendering.RenderStringFormatFlags enumeration that contains formatting information.

<filterpriority>1</filterpriority>

◆ LineAlignment

StringAlignment OFT.Rendering.Tools.RenderStringFormat.LineAlignment = StringAlignment.Near
getset

Gets or sets the line alignment on the horizontal plane.

Returns
A T:OFT.Rendering.RenderStringAlignment enumeration that represents the line alignment.

<filterpriority>1</filterpriority>

◆ Trimming

StringTrimming OFT.Rendering.Tools.RenderStringFormat.Trimming = StringTrimming.Character
getset

Gets or sets the T:OFT.Rendering.RenderStringTrimming enumeration for this T:OFT.Rendering.StringFormat object.

Returns
A T:OFT.Rendering.RenderStringTrimming enumeration that indicates how text drawn with this T:OFT.Rendering.StringFormat object is trimmed when it exceeds the edges of the layout rectangle.

<filterpriority>1</filterpriority>

The documentation for this class was generated from the following file: