ScaleLabelOptions.FormatString Property

Gets or sets a value that specifies the format string for the display text on a scale.

Namespace: DevExpress.Xpf.Gauges

Assembly: DevExpress.Xpf.Gauges.v18.2.dll

Declaration

C#

public string FormatString { get; set; }

VB.NET

Public Property FormatString As String

Property Value

Type	Description
String	A String value that is the format string of a label.

Property Paths

You can access this nested property as listed below:

Object Type	Path to FormatString
ArcScale	.LabelOptions.FormatString
LinearScale	.LabelOptions.FormatString

Remarks

Use the FormatString property to define the specific string format for the scale’s label.

The following images illustrate some of string formats for the Circular Scale:

{0:0}	{0:f1}	{0:c1}

For more information on labels, refer to the Labels (Circular Scale) and Labels (Linear Scale) documents.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the FormatString property.

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#

pivotgridcontrol-and-gaugecontrol-integration-e3332/CS/PivotGauges/MainWindow.xaml#L56

<dxga:LinearScale.LabelOptions>
    <dxga:LinearScaleLabelOptions FormatString="{}{0:C2}M" Multiplier="1E-06" />
</dxga:LinearScale.LabelOptions>