AppearanceObject.GetStringFormat() Method

Gets the formatting attributes specified by the appearance object’s settings.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v24.1.dll

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

Declaration

C#

public StringFormat GetStringFormat()

VB.NET

Public Function GetStringFormat As StringFormat

Returns

Type	Description
StringFormat	A StringFormat object which specifies formatting attributes, such as the line spacing and alignment.

Remarks

The formatting attributes are specified by the text options which can be accessed via the AppearanceObject.TextOptions property.

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#

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

Color captionColor = EditorsSkins.GetSkin(viewInfo.LookAndFeel.ActiveLookAndFeel)[EditorsSkins.SkinEditorButton].Color.GetForeColor();
info.Cache.DrawString(str_value, viewInfo.Appearance.Font, new SolidBrush(captionColor), info.Bounds, info.Appearance.GetStringFormat());
return;

winforms-grid-show-editor-buttons-on-cell-hover/CS/WindowsApplication3/Form1.cs#L48

info.EditorButtonPainter.DrawObject(args);
e.Cache.DrawString(e.DisplayText, e.Appearance.Font, e.Appearance.GetForeBrush(e.Cache), textRect, e.Appearance.GetStringFormat());
e.Handled = true;

winforms-tabcontrol-paint-tab-header-text-vertically/CS/WindowsFormsApplication907/MySkinTabPainter.cs#L33

        a.GetFont(),Brushes.Green ,
        a.GetStringFormat(), pInfo.Text, angle, hotKeyPrefixOverride);
}

winforms-grid-print-export-custom-painted-content/CS/MyXtraGrid/Form1.cs#L68

e.Cache.FillRectangle(Brushes.Green, e.Bounds);
e.Cache.Paint.DrawString(e.Cache, "Hello, friend!!!", this.Font, Brushes.Red, e.Bounds, e.Appearance.GetStringFormat());
e.Handled = true;

winforms-xtraform-center-caption/CS/WindowsApplication1/Custom Form Painter/CustomFormPainter.cs#L43

    DrawTextShadow(cache, appearance, r);
    cache.DrawString(text, appearance.Font, appearance.GetForeBrush(cache), r, appearance.GetStringFormat());
}

VB.NET

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

Dim captionColor As Color = EditorsSkins.GetSkin(viewInfo.LookAndFeel.ActiveLookAndFeel)(EditorsSkins.SkinEditorButton).Color.GetForeColor()
info.Cache.DrawString(str_value, viewInfo.Appearance.Font, New SolidBrush(captionColor), info.Bounds, info.Appearance.GetStringFormat())
Return

winforms-grid-show-editor-buttons-on-cell-hover/VB/WindowsApplication3/Form1.vb#L51

info.EditorButtonPainter.DrawObject(args)
e.Cache.DrawString(e.DisplayText, e.Appearance.Font, e.Appearance.GetForeBrush(e.Cache), textRect, e.Appearance.GetStringFormat())
e.Handled = True

winforms-grid-print-export-custom-painted-content/VB/MyXtraGrid/Form1.vb#L66

e.Cache.FillRectangle(Brushes.Green, e.Bounds)
e.Cache.Paint.DrawString(e.Cache, "Hello, friend!!!", Me.Font, Brushes.Red, e.Bounds, e.Appearance.GetStringFormat())
e.Handled = True

winforms-xtraform-center-caption/VB/WindowsApplication1/Custom Form Painter/CustomFormPainter.vb#L49

    DrawTextShadow(cache, appearance, r)
    cache.DrawString(text, appearance.Font, appearance.GetForeBrush(cache), r, appearance.GetStringFormat())
End Sub

winforms-grid-display-custom-rows/VB/CustomRowInGrid/BlankItem.vb#L39

    drawRect.Inflate(-3, -3)
    e.Cache.DrawString(Text, gri.Appearance.Font, gri.Appearance.GetForeBrush(e.Cache), drawRect, gri.Appearance.GetStringFormat())
End Sub