TextOptions.GetStringFormat() Method

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

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v18.2.dll

Declaration

C#

public StringFormat GetStringFormat()

VB.NET

Public Function GetStringFormat As StringFormat

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 TextOptions.DefaultOptions object.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetStringFormat() 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#

how-to-use-all-day-header-to-display-scheduled-time-statistics-e121/CS/Form1.cs#L47

e.Cache.FillRectangle(brush, e.Bounds);
e.Cache.DrawString(string.Format("{0:P}", percent), cell.Appearance.Font, Brushes.Black, e.Bounds, cell.Appearance.TextOptions.GetStringFormat());
e.Handled = true;

how-to-calculate-and-display-totals-for-visible-appointments-e977/CS/Form1.cs#L65

ResourceHeader rh = (ResourceHeader)e.ObjectInfo;
StringFormat sf = rh.Appearance.HeaderCaption.TextOptions.GetStringFormat();

VB.NET

how-to-use-all-day-header-to-display-scheduled-time-statistics-e121/VB/Form1.vb#L45

e.Cache.FillRectangle(brush, e.Bounds)
e.Cache.DrawString(String.Format("{0:P}", percent), cell.Appearance.Font, Brushes.Black, e.Bounds, cell.Appearance.TextOptions.GetStringFormat())
e.Handled = True

how-to-calculate-and-display-totals-for-visible-appointments-e977/VB/Form1.vb#L67

Dim rh As ResourceHeader = CType(e.ObjectInfo, ResourceHeader)
Dim sf As StringFormat = rh.Appearance.HeaderCaption.TextOptions.GetStringFormat()