TextOptions.GetStringFormat(TextOptions) Method

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

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v24.1.dll

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

Declaration

C#

public StringFormat GetStringFormat(
    TextOptions defaultOptions
)

VB.NET

Public Function GetStringFormat(
    defaultOptions As TextOptions
) As StringFormat

Parameters

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

Returns

Type	Description
StringFormat	A StringFormat object whose properties are set to match the appropriate values.

Remarks

This method returns a StringFormat 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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetStringFormat(TextOptions) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-custom-buttonedit-display-editvalue-on-button/CS/TestMyButtonEdit/MyButtonEditPainter.cs#L42

    bounds = new Rectangle(bounds.X, bounds.Y, text_width, bounds.Height);
    appearance.DrawString(info.Cache, text, bounds, appearance.GetForeBrush(info.Cache), appearance.GetTextOptions().GetStringFormat(info.ViewInfo.DefaultTextOptions));
}

VB.NET

winforms-custom-buttonedit-display-editvalue-on-button/VB/TestMyButtonEdit/MyButtonEditPainter.vb#L41

    bounds = New Rectangle(bounds.X, bounds.Y, text_width, bounds.Height)
    appearance.DrawString(info.Cache, text, bounds, appearance.GetForeBrush(info.Cache), appearance.GetTextOptions().GetStringFormat(info.ViewInfo.DefaultTextOptions))
End Sub