TextOptions Members

Contains options that specify how text is rendered.

Constructors

Name	Description
TextOptions(AppearanceObject)	Initializes a new instance of the TextOptions class with the specified owner, the text settings are set to default values.
TextOptions(HorzAlignment, VertAlignment, WordWrap, Trimming, HKeyPrefix)	Initializes a new instance of the TextOptions class with the specified alignments, word wrapping and text trimming options.
TextOptions(HorzAlignment, VertAlignment, WordWrap, Trimming)	Initializes a new instance of the TextOptions class with the specified alignments, word wrapping and text trimming options.

Properties

Name	Description
DefaultOptions static	Gets an object that specifies the default text options.
DefaultOptionsCenteredWithEllipsis static	Gets an object whose settings force text to be centered.
DefaultOptionsMultiLine static	Gets an object whose settings allow text to wrap.
DefaultOptionsNoWrap static	Gets an object whose settings prevent text from wrapping.
DefaultOptionsNoWrapEx static	Gets an object whose settings force text to be centered and prevent it from wrapping.
DefaultStringFormat static	Gets an object that contains the default formatting settings.
HAlignment	Gets or sets the horizontal alignment of text.
HotkeyPrefix	Gets or sets whether to underline characters that are preceded with an ampersand symbol (&). This option is supported by a set of controls.
RightToLeft	Gets or sets whether the text is directed from right to left.
Trimming	Gets or sets text trimming mode.
VAlignment	Gets or sets the vertical alignment of text.
WordWrap	Gets or sets text wrapping mode.

Methods

Name	Description
Assign(TextOptions)	Copies settings from the specified object to the current TextOptions object.
BeginUpdate()	Prevents a text’s visual updates when TextOptions are modified, until the EndUpdate() or CancelUpdate() method is called.
CancelUpdate()	Enables a text’s visual updates if the text was previously locked by the BeginUpdate() method. Does not cause the text’s immediate visual update.
EndUpdate()	Enables a text’s visual updates if the text was previously locked by the BeginUpdate() method. Causes the text’s immediate visual update.
Equals(Object, Object) static	Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)	Determines whether the specified object is equal to the current object. Inherited from Object.
ForceUseGenericDefaultStringFormat() static	Specifies how the default string format referred to by the TextOptions.DefaultStringFormat property is constructed.
GetDXStringFormat()	Returns an object that contains text alignment information and OpenType features.
GetDXStringFormat(TextOptions)	Returns an object that contains text alignment information and OpenType features.
GetHashCode()	Serves as the default hash function. Inherited from Object.
GetStringFormat()	Returns a StringFormat object whose settings reflect the alignment, word wrapping and text trimming options of the TextOptions.DefaultOptions object.
GetStringFormat(TextOptions)	Returns a StringFormat object whose settings reflect the alignment, word wrapping and text trimming options of the specified TextOptions object.
GetStringFormatInfo()	Returns a StringFormatInfo object whose settings reflect the alignment, word wrapping and text trimming options of the TextOptions.DefaultOptions object.
GetStringFormatInfo(TextOptions)	Returns a StringFormatInfo object whose settings reflect the alignment, word wrapping and text trimming options of the TextOptions.DefaultOptions object.
GetType()	Gets the Type of the current instance. Inherited from Object.
HorzAlignmentToStringAlignment(HorzAlignment) static	Obsolete. Converts the specified HorzAlignment value to a corresponding StringAlignment value.
IsEqual(TextOptions)	Tests whether two objects have the same property values.
MemberwiseClone() protected	Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static	Determines whether the specified Object instances are the same instance. Inherited from Object.
Reset()	Resets all the text settings to their default values.
SetHAlignment(HorzAlignment)	Specifies a text’s horizontal alignment within a control.
SetHAlignmentCore(HorzAlignment)	This is an internal method that should not be called directly from your code.
SetHotKeyPrefix(HKeyPrefix)	Sets the TextOptions.HotkeyPrefix property without the property changed notifications.
ToString()	Returns the text representation of the current object.
UpdateDefaultOptions(TextOptions)	For internal use. Copies settings from the specified object to the current object.
VertAlignmentToStringAlignment(VertAlignment) static	Obsolete. Converts the specified VertAlignment value to a corresponding StringAlignment value.