com.aspose.drawing

Class StringFormat

java.lang.Object

com.aspose.drawing.StringFormat

All Implemented Interfaces:

com.aspose.ms.System.IDisposable

public final class StringFormat
extends Object
implements com.aspose.ms.System.IDisposable

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.

Constructor Summary

Constructors

Constructor and Description
StringFormat() Initializes a new instance of the StringFormat class.
StringFormat(int options) Initializes a new instance of the StringFormat class with the specified StringFormatFlags enumeration.
StringFormat(int options, int language) Initializes a new instance of the StringFormat class with the specified StringFormatFlags enumeration and language.
StringFormat(StringFormat format) Initializes a new instance of the StringFormat class from the specified existing StringFormat object.

Method Summary

Modifier and Type	Method and Description
StringFormat	deepClone() Creates an exact copy of this StringFormat object.
void	dispose() Releases all resources used by this StringFormat object.
int	getAlignment() Gets or sets text alignment information on the vertical plane.
int	getDigitSubstitutionLanguage() Gets the language that is used when local digits are substituted for western digits.
int	getDigitSubstitutionMethod() Gets the method to be used for digit substitution.
float	getFirstTabOffset()
int	getFormatFlags() Gets or sets a StringFormatFlags enumeration that contains formatting information.
static StringFormat	getGenericDefault() Gets a generic default StringFormat object.
static StringFormat	getGenericTypographic() Gets a generic typographic StringFormat object.
int	getHotkeyPrefix() Gets or sets the HotkeyPrefix(StringFormat.getHotkeyPrefix()/StringFormat.setHotkeyPrefix(int)) object for this StringFormat object.
int	getLineAlignment() Gets or sets the line alignment on the horizontal plane.
float[]	getTabStops() Gets an array of distances between tab stops in the units specified by the Aspose.Imaging.getGraphics().PageUnit property.
float[]	getTabStops(float[] firstTabOffset) Gets the tab stops for this StringFormat object.
int	getTrimming() Gets or sets the StringTrimming enumeration for this StringFormat object.
void	setAlignment(int value) Gets or sets text alignment information on the vertical plane.
void	setDigitSubstitution(int language, int substitute) Specifies the language and method to be used when local digits are substituted for western digits.
void	setDigitSubstitutionLanguage(int value)
void	setDigitSubstitutionMethod(int value)
void	setFormatFlags(int value) Gets or sets a StringFormatFlags enumeration that contains formatting information.
void	setHotkeyPrefix(int value) Gets or sets the HotkeyPrefix(StringFormat.getHotkeyPrefix()/StringFormat.setHotkeyPrefix(int)) object for this StringFormat object.
void	setLineAlignment(int value) Gets or sets the line alignment on the horizontal plane.
void	setMeasurableCharacterRanges(CharacterRange[] ranges) Specifies an array of CharacterRange structures that represent the ranges of characters measured by a call to the MeasureCharacterRanges method.
void	setTabStops(float firstTabOffset, float[] tabStops) Sets tab stops for this StringFormat object.
void	setTrimming(int value) Gets or sets the StringTrimming enumeration for this StringFormat object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringFormat

public StringFormat()

Initializes a new instance of the StringFormat class.

StringFormat

public StringFormat(StringFormat format)

Initializes a new instance of the StringFormat class from the specified existing StringFormat object.

Parameters:

format - The StringFormat object from which to initialize the new StringFormat object.

StringFormat

public StringFormat(int options,
                    int language)

Initializes a new instance of the StringFormat class with the specified StringFormatFlags enumeration and language.

Parameters:

options - The StringFormatFlags enumeration for the new StringFormat object.

language - A value that indicates the language of the text.

StringFormat

public StringFormat(int options)

Initializes a new instance of the StringFormat class with the specified StringFormatFlags enumeration.

Parameters:

options - The StringFormatFlags enumeration for the new StringFormat object.

Method Detail

setDigitSubstitutionLanguage

public void setDigitSubstitutionLanguage(int value)

setDigitSubstitutionMethod

public void setDigitSubstitutionMethod(int value)

getFirstTabOffset

public float getFirstTabOffset()

getGenericDefault

public static StringFormat getGenericDefault()

Gets a generic default StringFormat object.

getGenericTypographic

public static StringFormat getGenericTypographic()

Gets a generic typographic StringFormat object.

Returns:

A generic typographic StringFormat object.

getFormatFlags

public int getFormatFlags()

Gets or sets a StringFormatFlags enumeration that contains formatting information.

setFormatFlags

public void setFormatFlags(int value)

Gets or sets a StringFormatFlags enumeration that contains formatting information.

getAlignment

public int getAlignment()

Gets or sets text alignment information on the vertical plane.

setAlignment

public void setAlignment(int value)

Gets or sets text alignment information on the vertical plane.

getLineAlignment

public int getLineAlignment()

Gets or sets the line alignment on the horizontal plane.

setLineAlignment

public void setLineAlignment(int value)

Gets or sets the line alignment on the horizontal plane.

getHotkeyPrefix

public int getHotkeyPrefix()

Gets or sets the HotkeyPrefix(StringFormat.getHotkeyPrefix()/StringFormat.setHotkeyPrefix(int)) object for this StringFormat object.

setHotkeyPrefix

public void setHotkeyPrefix(int value)

Gets or sets the HotkeyPrefix(StringFormat.getHotkeyPrefix()/StringFormat.setHotkeyPrefix(int)) object for this StringFormat object.

getTrimming

public int getTrimming()

Gets or sets the StringTrimming enumeration for this StringFormat object.

setTrimming

public void setTrimming(int value)

Gets or sets the StringTrimming enumeration for this StringFormat object.

getDigitSubstitutionLanguage

public int getDigitSubstitutionLanguage()

Gets the language that is used when local digits are substituted for western digits.

Returns:

A National Language Support (NLS) language identifier that identifies the language that will be used when local digits are substituted for western digits. You can pass the System.Globalization.CultureInfo.LCID property of a Locale object as the NLS language identifier. For example, suppose you create a Locale object by passing the string "ar-EG" to a Locale constructor. If you pass the System.Globalization.CultureInfo.LCID property of that Locale object along with.StringDigitSubstitute.Traditional to the StringFormat.setDigitSubstitution(int,int) method, then Arabic-Indic digits will be substituted for western digits at display time.

getDigitSubstitutionMethod

public int getDigitSubstitutionMethod()

Gets the method to be used for digit substitution.

Returns:

A StringDigitSubstitute enumeration value that specifies how to substitute characters in a string that cannot be displayed because they are not supported by the current font.

dispose

public void dispose()

Releases all resources used by this StringFormat object.

Specified by:

dispose in interface com.aspose.ms.System.IDisposable

deepClone

public StringFormat deepClone()

Creates an exact copy of this StringFormat object.

Returns:

The StringFormat object this method creates.

getTabStops

public float[] getTabStops(float[] firstTabOffset)

Gets the tab stops for this StringFormat object.

Parameters:

firstTabOffset - The number of spaces between the beginning of a text line and the first tab stop.

Returns:

An array of distances (in number of spaces) between tab stops.

getTabStops

public float[] getTabStops()

Gets an array of distances between tab stops in the units specified by the Aspose.Imaging.getGraphics().PageUnit property.

Returns:

The tab stops.

The property is introduced for removed method GetTabStops.

setTabStops

public void setTabStops(float firstTabOffset,
                        float[] tabStops)

Sets tab stops for this StringFormat object.

Parameters:

firstTabOffset - The number of spaces between the beginning of a line of text and the first tab stop.

tabStops - An array of distances between tab stops in the units specified by the Graphics.PageUnit property.

setDigitSubstitution

public void setDigitSubstitution(int language,
                                 int substitute)

Specifies the language and method to be used when local digits are substituted for western digits.

Parameters:

language - A National Language Support (NLS) language identifier that identifies the language that will be used when local digits are substituted for western digits. You can pass the System.Globalization.CultureInfo.LCID property of a Locale object as the NLS language identifier. For example, suppose you create a Locale object by passing the string "ar-EG" to a Locale constructor. If you pass the System.Globalization.CultureInfo.LCID property of that Locale object along with StringDigitSubstitute.Traditional to the M:StringFormat.SetDigitSubstitution(System.Int32,StringDigitSubstitute) method, then Arabic-Indic digits will be substituted for western digits at display time.

substitute - An element of the StringDigitSubstitute enumeration that specifies how digits are displayed.

setMeasurableCharacterRanges

public void setMeasurableCharacterRanges(CharacterRange[] ranges)

Specifies an array of CharacterRange structures that represent the ranges of characters measured by a call to the MeasureCharacterRanges method.

Parameters:

ranges - An array of CharacterRange structures that specifies the ranges of characters measured by a call to the MeasureCharacterRanges method.