StringFormat Class
Summary: 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.
Module: aspose.imaging
Full Name: aspose.imaging.StringFormat
Inheritance: DisposableObject
Constructors
| Name | Description |
|---|---|
| StringFormat() | Initializes a new StringFormat object. |
| StringFormat(format) | Initializes a new StringFormat object from the specified existing StringFormat object. |
| StringFormat(options) | Initializes a new StringFormat object with the specified StringFormatFlags enumeration and language. |
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| alignment | StringAlignment | r/w | Gets or sets text alignment information on the vertical plane. |
| custom_char_ident | PointF | r/w | Gets or sets the custom character ident. |
| digit_substitution_language | int | r/w | Gets or sets the language that is used when local digits are substituted for western digits. |
| digit_substitution_method | StringDigitSubstitute | r/w | Gets or sets the method to be used for digit substitution. |
| disposed | bool | r | Gets a value indicating whether this instance is disposed. |
| first_tab_offset | float | r | Gets the number of spaces between the beginning of a line of text and the first tab stop. |
| format_flags | StringFormatFlags | r/w | Gets or sets a StringFormatFlags enumeration that contains formatting information. |
| generic_default [static] | StringFormat | r | Gets a generic default StringFormat object. |
| generic_typographic [static] | StringFormat | r | Gets a generic typographic StringFormat object. |
| hotkey_prefix | HotkeyPrefix | r/w | Gets or sets the HotkeyPrefix object for this StringFormat object. |
| line_alignment | StringAlignment | r/w | Gets or sets the line alignment on the horizontal plane. |
| tab_stops | float | r | Gets an array of distances between tab stops in the units specified by the Graphics.page_unit property. |
| trimming | StringTrimming | r/w | Gets or sets the StringTrimming enumeration for this StringFormat object. |
Methods
| Name | Description |
|---|---|
| create_from_flags(options) | Initializes a new StringFormat object with the specified StringFormatFlags enumeration and language. |
| create_from_format(format) | Initializes a new StringFormat object from the specified existing StringFormat object. |
| deep_clone() | Creates a deep clone of this StringFormat object. |
| set_tab_stops(first_tab_offset, tab_stops) | Sets tab stops for this StringFormat object. |
Constructor: StringFormat()
StringFormat()
Initializes a new StringFormat object.
Constructor: StringFormat(format)
StringFormat(format)
Initializes a new StringFormat object from the specified existing StringFormat object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| format | StringFormat | The StringFormat object from which to initialize the new StringFormat object. |
Constructor: StringFormat(options)
StringFormat(options)
Initializes a new StringFormat object with the specified StringFormatFlags enumeration and language.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | StringFormatFlags | The StringFormatFlags enumeration for the new StringFormat object. |
Method: create_from_flags(options) [static]
create_from_flags(options)
Initializes a new StringFormat object with the specified StringFormatFlags enumeration and language.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | StringFormatFlags | The StringFormatFlags enumeration for the new StringFormat object. |
Returns
| Type | Description |
|---|---|
| StringFormat |
Method: create_from_format(format) [static]
create_from_format(format)
Initializes a new StringFormat object from the specified existing StringFormat object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| format | StringFormat | The StringFormat object from which to initialize the new StringFormat object. |
Returns
| Type | Description |
|---|---|
| StringFormat |
Method: deep_clone()
deep_clone()
Creates a deep clone of this StringFormat object.
Returns
| Type | Description |
|---|---|
| StringFormat | The deep clone of the current StringFormat. |
Method: set_tab_stops(first_tab_offset, tab_stops)
set_tab_stops(first_tab_offset, tab_stops)
Sets tab stops for this StringFormat object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| first_tab_offset | float | The number of spaces between the beginning of a line of text and the first tab stop. |
| tab_stops | float | An array of distances between tab stops in the units specified by the Graphics.page_unit property. |