Class RenderStringFormat
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.
public sealed class RenderStringFormat
- Inheritance
-
objectRenderStringFormat
- Extension Methods
Constructors
RenderStringFormat()
public RenderStringFormat()
Properties
Alignment
Gets or sets text alignment information on the vertical plane.
public StringAlignment Alignment { get; set; }
Property Value
- StringAlignment
A OFT.Rendering.RenderStringAlignment enumeration that specifies text alignment information.
FormatFlags
Gets or sets a OFT.Rendering.RenderStringFormatFlags enumeration that contains formatting information.
public StringFormatFlags FormatFlags { get; set; }
Property Value
- StringFormatFlags
A OFT.Rendering.RenderStringFormatFlags enumeration that contains formatting information.
LineAlignment
Gets or sets the line alignment on the horizontal plane.
public StringAlignment LineAlignment { get; set; }
Property Value
- StringAlignment
A OFT.Rendering.RenderStringAlignment enumeration that represents the line alignment.
Trimming
Gets or sets the OFT.Rendering.RenderStringTrimming enumeration for this OFT.Rendering.StringFormat object.
public StringTrimming Trimming { get; set; }
Property Value
- StringTrimming
A OFT.Rendering.RenderStringTrimming enumeration that indicates how text drawn with this OFT.Rendering.StringFormat object is trimmed when it exceeds the edges of the layout rectangle.
Methods
Clone()
Creates a new format with the same alignment, line alignment, format flags and trimming.
public RenderStringFormat Clone()
Returns
- RenderStringFormat
The copy.
Equals(RenderStringFormat?)
Determines whether other has the same alignment, line alignment, format flags and trimming.
Added in ATAS 8.0.15.
public bool Equals(RenderStringFormat? other)
Parameters
otherRenderStringFormatFormat to compare with.
Returns
Equals(object?)
Determines whether obj is a RenderStringFormat with the same values; see Equals(RenderStringFormat?).
Added in ATAS 8.0.15.
public override bool Equals(object? obj)
Parameters
objobjectObject to compare with.
Returns
- bool
true when the formats are equal.
GetHashCode()
Returns a hash code computed from the alignment, format flags, line alignment and trimming. The properties are mutable, so do not change a format while it is a key in a hash-based collection.
public override int GetHashCode()
Returns
- int
The hash code.
ToString()
Converts this OFT.Rendering.StringFormat object to a human-readable string.
public override string ToString()
Returns
- string
A string representation of this OFT.Rendering.StringFormat object.