AppearanceObject.GetStringFormat() Method

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

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v19.1.dll

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-schedulercontrol-api-t224044/CS/SchedulerAPISample/CodeExamples/CustomDraw.cs#L127

    Brushes.White, innerRect,
    header.Appearance.HeaderCaption.GetStringFormat());
e.Handled = true;

how-to-display-a-hyperlink-over-the-views-empty-area-when-no-records-are-shown-e1898/CS/WindowsApplication1/MyHelper.cs#L129

{
    e.Cache.DrawString(NoMatchesFoundText, PaintFont, Brushes.Gray, NoMatchesFoundBounds(e.Bounds), e.Appearance.GetStringFormat());
}

how-to-create-a-buttonedit-descendant-showing-editvalue-in-buttons-caption-e3469/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;

how-to-create-a-custom-buttonedit-descendant-that-displays-its-value-in-the-first-button-e1954/CS/WindowsApplication1/CustomEditor/MySkinEditorButtonPainter.cs#L25

    string caption = OwnerEditInfo == null? ee.Button.Caption : OwnerEditInfo.DisplayText;
    ButtonPainter.DrawCaption(ee, caption, ee.Appearance.Font, GetForeBrush(ee), e.Bounds, ee.Appearance.GetStringFormat());
}

how-to-display-buttons-with-different-captions-in-different-rows-of-gridview-e4024/CS/CS/WindowsApplication1/CustomEditor/ExtendedSkinEditorButtonPainter.cs#L25

    string caption = ((ExtendedButtonEditViewInfo)OwnerEditInfo).GetButtonCaption(ee.Button);
    ButtonPainter.DrawCaption(ee, caption, ee.Appearance.Font, GetForeBrush(ee), e.Bounds, ee.Appearance.GetStringFormat());
}

VB.NET

winforms-schedulercontrol-api-t224044/VB/SchedulerAPISample/CodeExamples/CustomDraw.vb#L120

' Draw the header caption.
e.Cache.DrawString(header.Caption, header.Appearance.HeaderCaption.Font, Brushes.White, innerRect, header.Appearance.HeaderCaption.GetStringFormat())
e.Handled = True

how-to-display-a-hyperlink-over-the-views-empty-area-when-no-records-are-shown-e1898/VB/WindowsApplication1/MyHelper.vb#L128

Private Sub DrawNoMatchesFound(ByVal e As CustomDrawEventArgs)
    e.Cache.DrawString(NoMatchesFoundText, PaintFont, Brushes.Gray, NoMatchesFoundBounds(e.Bounds), e.Appearance.GetStringFormat())
End Sub

how-to-create-a-buttonedit-descendant-showing-editvalue-in-buttons-caption-e3469/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

how-to-create-a-custom-buttonedit-descendant-that-displays-its-value-in-the-first-button-e1954/VB/WindowsApplication1/CustomEditor/MySkinEditorButtonPainter.vb#L31

    Dim caption As String = If(OwnerEditInfo Is Nothing, ee.Button.Caption, OwnerEditInfo.DisplayText)
    ButtonPainter.DrawCaption(ee, caption, ee.Appearance.Font, GetForeBrush(ee), e.Bounds, ee.Appearance.GetStringFormat())
End Sub

how-to-display-buttons-with-different-captions-in-different-rows-of-gridview-e4024/VB/WindowsApplication1/CustomEditor/ExtendedSkinEditorButtonPainter.vb#L31

    Dim caption As String = (CType(OwnerEditInfo, ExtendedButtonEditViewInfo)).GetButtonCaption(ee.Button)
    ButtonPainter.DrawCaption(ee, caption, ee.Appearance.Font, GetForeBrush(ee), e.Bounds, ee.Appearance.GetStringFormat())
End Sub