public final class EmfPlusStringFormat extends EmfPlusGraphicsObjectType
The EmfPlusStringFormat object specifies text layout, display manipulations, and language identification
Constructor and Description |
---|
EmfPlusStringFormat() |
Modifier and Type | Method and Description |
---|---|
short |
getDigitLanguage()
Gets or sets an EmfPlusLanguageIdentifier object that specifies the
language to use for numeric digits in the string.
|
int |
getDigitSubstitution()
Gets or sets a 32-bit unsigned integer that specifies how to substitute
numeric digits in the string according to a locale or language.
|
float |
getFirstTabOffset()
Gets or sets a 32-bit floating-point value that specifies the number
of spaces between the beginning of a text line and
the first tab stop
|
int |
getHotkeyPrefix()
Gets or sets a 32-bit signed integer that specifies the type of
processing that is performed on a string when a keyboard
shortcut prefix (that is, an ampersand) is encountered.
|
short |
getLanguage()
Gets or sets an EmfPlusLanguageIdentifier object (section 2.2.2.23)
that specifies the language to use for the string
|
float |
getLeadingMargin()
Gets or sets a 32-bit floating-point value that specifies the length
of the space to add to the starting position of a string.
|
int |
getLineAlign()
Gets or sets a 32-bit unsigned integer that specifies how to
align the string vertically in the layout rectangle.
|
int |
getRangeCount()
Gets or sets a 32-bit signed integer that specifies the number of EmfPlusCharacterRange
objects (section 2.2.2.8) defined in the StringFormatData field.
|
int |
getStringAlignment()
Gets or sets a 32-bit unsigned integer that specifies how to
align the string horizontally in the layout rectangle.
|
EmfPlusStringFormatData |
getStringFormatData()
Gets or sets an EmfPlusStringFormatData object (section 2.2.2.44)
that specifies optional text layout data.
|
long |
getStringFormatFlags()
Gets or sets a 32-bit unsigned integer that specifies text layout
options for formatting, clipping and font handling.
|
int |
getTabstopCount()
Gets or sets a 32-bit signed integer that specifies the number of tab stops
defined in the StringFormatData field.
|
float |
getTracking()
Gets or sets a 32-bit floating-point value that specifies the ratio
of the horizontal space allotted to each character in
a specified string to the font-defined width of the
character.
|
float |
getTrailingMargin()
Gets or sets a 32-bit floating-point value that specifies the length
of the space to leave following a string.
|
int |
getTrimming()
Gets or sets specifies how to trim characters from a string that is
too large to fit into a layout rectangle.
|
void |
setDigitLanguage(short value)
Gets or sets an EmfPlusLanguageIdentifier object that specifies the
language to use for numeric digits in the string.
|
void |
setDigitSubstitution(int value)
Gets or sets a 32-bit unsigned integer that specifies how to substitute
numeric digits in the string according to a locale or language.
|
void |
setFirstTabOffset(float value)
Gets or sets a 32-bit floating-point value that specifies the number
of spaces between the beginning of a text line and
the first tab stop
|
void |
setHotkeyPrefix(int value)
Gets or sets a 32-bit signed integer that specifies the type of
processing that is performed on a string when a keyboard
shortcut prefix (that is, an ampersand) is encountered.
|
void |
setLanguage(short value)
Gets or sets an EmfPlusLanguageIdentifier object (section 2.2.2.23)
that specifies the language to use for the string
|
void |
setLeadingMargin(float value)
Gets or sets a 32-bit floating-point value that specifies the length
of the space to add to the starting position of a string.
|
void |
setLineAlign(int value)
Gets or sets a 32-bit unsigned integer that specifies how to
align the string vertically in the layout rectangle.
|
void |
setRangeCount(int value)
Gets or sets a 32-bit signed integer that specifies the number of EmfPlusCharacterRange
objects (section 2.2.2.8) defined in the StringFormatData field.
|
void |
setStringAlignment(int value)
Gets or sets a 32-bit unsigned integer that specifies how to
align the string horizontally in the layout rectangle.
|
void |
setStringFormatData(EmfPlusStringFormatData value)
Gets or sets an EmfPlusStringFormatData object (section 2.2.2.44)
that specifies optional text layout data.
|
void |
setStringFormatFlags(long value)
Gets or sets a 32-bit unsigned integer that specifies text layout
options for formatting, clipping and font handling.
|
void |
setTabstopCount(int value)
Gets or sets a 32-bit signed integer that specifies the number of tab stops
defined in the StringFormatData field.
|
void |
setTracking(float value)
Gets or sets a 32-bit floating-point value that specifies the ratio
of the horizontal space allotted to each character in
a specified string to the font-defined width of the
character.
|
void |
setTrailingMargin(float value)
Gets or sets a 32-bit floating-point value that specifies the length
of the space to leave following a string.
|
void |
setTrimming(int value)
Gets or sets specifies how to trim characters from a string that is
too large to fit into a layout rectangle.
|
getVersion, setVersion
public short getDigitLanguage()
Gets or sets an EmfPlusLanguageIdentifier object that specifies the language to use for numeric digits in the string. For example, if this string contains Arabic digits, this field MUST contain a language identifier that specifies an Arabic language
public void setDigitLanguage(short value)
Gets or sets an EmfPlusLanguageIdentifier object that specifies the language to use for numeric digits in the string. For example, if this string contains Arabic digits, this field MUST contain a language identifier that specifies an Arabic language
public int getDigitSubstitution()
Gets or sets a 32-bit unsigned integer that specifies how to substitute numeric digits in the string according to a locale or language. This value MUST be defined in the StringDigitSubstitution enumeration (section 2.1.1.30).
public void setDigitSubstitution(int value)
Gets or sets a 32-bit unsigned integer that specifies how to substitute numeric digits in the string according to a locale or language. This value MUST be defined in the StringDigitSubstitution enumeration (section 2.1.1.30).
public float getFirstTabOffset()
Gets or sets a 32-bit floating-point value that specifies the number of spaces between the beginning of a text line and the first tab stop
public void setFirstTabOffset(float value)
Gets or sets a 32-bit floating-point value that specifies the number of spaces between the beginning of a text line and the first tab stop
public int getHotkeyPrefix()
Gets or sets a 32-bit signed integer that specifies the type of processing that is performed on a string when a keyboard shortcut prefix (that is, an ampersand) is encountered. Basically, this field specifies whether to display keyboard shortcut prefixes that relate to text. The value MUST be defined in the HotkeyPrefix enumeration (section 2.1.1.14).
public void setHotkeyPrefix(int value)
Gets or sets a 32-bit signed integer that specifies the type of processing that is performed on a string when a keyboard shortcut prefix (that is, an ampersand) is encountered. Basically, this field specifies whether to display keyboard shortcut prefixes that relate to text. The value MUST be defined in the HotkeyPrefix enumeration (section 2.1.1.14).
public short getLanguage()
Gets or sets an EmfPlusLanguageIdentifier object (section 2.2.2.23) that specifies the language to use for the string
public void setLanguage(short value)
Gets or sets an EmfPlusLanguageIdentifier object (section 2.2.2.23) that specifies the language to use for the string
public float getLeadingMargin()
Gets or sets a 32-bit floating-point value that specifies the length of the space to add to the starting position of a string. The default is 1/6 inch; for typographic fonts, the default value is 0.
public void setLeadingMargin(float value)
Gets or sets a 32-bit floating-point value that specifies the length of the space to add to the starting position of a string. The default is 1/6 inch; for typographic fonts, the default value is 0.
public int getLineAlign()
Gets or sets a 32-bit unsigned integer that specifies how to align the string vertically in the layout rectangle. This value MUST be defined in the StringAlignment enumeration.
public void setLineAlign(int value)
Gets or sets a 32-bit unsigned integer that specifies how to align the string vertically in the layout rectangle. This value MUST be defined in the StringAlignment enumeration.
public int getRangeCount()
Gets or sets a 32-bit signed integer that specifies the number of EmfPlusCharacterRange objects (section 2.2.2.8) defined in the StringFormatData field.
public void setRangeCount(int value)
Gets or sets a 32-bit signed integer that specifies the number of EmfPlusCharacterRange objects (section 2.2.2.8) defined in the StringFormatData field.
public int getStringAlignment()
Gets or sets a 32-bit unsigned integer that specifies how to align the string horizontally in the layout rectangle. This value MUST be defined in the StringAlignment enumeration (section 2.1.1.29).
public void setStringAlignment(int value)
Gets or sets a 32-bit unsigned integer that specifies how to align the string horizontally in the layout rectangle. This value MUST be defined in the StringAlignment enumeration (section 2.1.1.29).
public EmfPlusStringFormatData getStringFormatData()
Gets or sets an EmfPlusStringFormatData object (section 2.2.2.44) that specifies optional text layout data.
public void setStringFormatData(EmfPlusStringFormatData value)
Gets or sets an EmfPlusStringFormatData object (section 2.2.2.44) that specifies optional text layout data.
public long getStringFormatFlags()
Gets or sets a 32-bit unsigned integer that specifies text layout options for formatting, clipping and font handling. This value MUST be composed of StringFormat flags (section 2.1.2.8).
public void setStringFormatFlags(long value)
Gets or sets a 32-bit unsigned integer that specifies text layout options for formatting, clipping and font handling. This value MUST be composed of StringFormat flags (section 2.1.2.8).
public int getTabstopCount()
Gets or sets a 32-bit signed integer that specifies the number of tab stops defined in the StringFormatData field.
public void setTabstopCount(int value)
Gets or sets a 32-bit signed integer that specifies the number of tab stops defined in the StringFormatData field.
public float getTracking()
Gets or sets a 32-bit floating-point value that specifies the ratio of the horizontal space allotted to each character in a specified string to the font-defined width of the character. Large values for this property specify ample space between characters; values less than 1 can produce character overlap. The default is 1.03; for typographic fonts, the default value is 1.00.
public void setTracking(float value)
Gets or sets a 32-bit floating-point value that specifies the ratio of the horizontal space allotted to each character in a specified string to the font-defined width of the character. Large values for this property specify ample space between characters; values less than 1 can produce character overlap. The default is 1.03; for typographic fonts, the default value is 1.00.
public float getTrailingMargin()
Gets or sets a 32-bit floating-point value that specifies the length of the space to leave following a string. The default is 1/6 inch; for typographic fonts, the default value is 0.
public void setTrailingMargin(float value)
Gets or sets a 32-bit floating-point value that specifies the length of the space to leave following a string. The default is 1/6 inch; for typographic fonts, the default value is 0.
public int getTrimming()
Gets or sets specifies how to trim characters from a string that is too large to fit into a layout rectangle. This value MUST be defined in the StringTrimming enumeration (section 2.1.1.31).
public void setTrimming(int value)
Gets or sets specifies how to trim characters from a string that is too large to fit into a layout rectangle. This value MUST be defined in the StringTrimming enumeration (section 2.1.1.31).