TextOptions.GetStringFormatInfo(TextOptions) Method

Returns a StringFormatInfo object whose settings reflect the alignment, word wrapping and text trimming options of the TextOptions.DefaultOptions object.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v24.1.dll

NuGet Packages: DevExpress.Utils, DevExpress.Wpf.Core

Declaration

C#

public StringFormatInfo GetStringFormatInfo(
    TextOptions defaultOptions
)

VB.NET

Public Function GetStringFormatInfo(
    defaultOptions As TextOptions
) As StringFormatInfo

Parameters

Name	Type	Description
defaultOptions	TextOptions	A TextOptions object whose settings are used to initialize the corresponding settings of the StringFormatInfo object that is to be returned.

Returns

Type	Description
DevExpress.Utils.StringFormatInfo	A StringFormatInfo object whose properties are set to match the appropriate values.

Remarks

This method returns a StringFormatInfo object. Its FormatFlags, Alignment, Trimming and LineAlignment properties reflect the state of the TextOptions.WordWrap, TextOptions.HAlignment, TextOptions.Trimming and TextOptions.VAlignment properties of the defaultOptions parameter.