System::Drawing::StringFormat class

StringFormat class

Encapsulates text layout information, display manipulations and OpenType features. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

class StringFormat : public System::Object

Methods

MethodDescription
Clone()Returns an exact copy of the current object.
get_Alignment() constReturns a value that indicates horizontal alignment of the string.
get_DigitSubstitutionLanguage() constReturns a value that indicats the language that is used when local digits are substituted with western digits.
get_DigitSubstitutionMethod() constReturns digit substitution method.
get_FormatFlags() constReturns a bitwise combination of StringFormatFlags that specifies the string format represented by the current object.
static get_GenericDefault()Returns a StringFormat object that represents a generic default format.
static get_GenericTypographic()Returns a StringFormat object that represents a generic typographic format.
get_HotkeyPrefix() constReturns the value that indicates how the hot key prefix is displayed.
get_LineAlignment() constReturns a value that indicates vertical alignment of the string.
get_Trimming() constReturns a value that indicates how the string is trimmed.
GetCharacterRangesCount() constGets a size of the CharacterRange array.
GetTabStops(float&) constReturns the tab stops for the current StringFormat object.
set_Alignment(StringAlignment)Sets horizontal alignment of the string.
set_FormatFlags(StringFormatFlags)Sets the string format flags.
set_HotkeyPrefix(Text::HotkeyPrefix)Sets the value that specifies how the hot key prefix should be displayed.
set_LineAlignment(StringAlignment)Sets vertical alignment of the string.
set_Trimming(StringTrimming)Sets a value that specifies how the string is trimmed.
SetDigitSubstitution(int32_t, StringDigitSubstitute)Sets digit substitution language and method.
SetMeasurableCharacterRanges(const ArrayPtr<CharacterRange>&)Sets an array of CharacterRange objects that represent the chracter ranges measured by a call to the MeasureCharacterRanges() method.
SetTabStops(float, const ArrayPtr<float>&)Sets the tab stops for the current StringFormat object.
StringFormat()Constructs a new instance of StringFormat class.
StringFormat(StringFormatFlags, int32_t)Constructs a new instance of StringFormat class with the specified format flags and language.
StringFormat(const SharedPtr<StringFormat>&)Copy constructor.

See Also