ChartRangeControlClientGridOptions.LabelFormat Property

Gets or sets the string used to format chart client label values.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v18.2.dll

Declaration

C#

[XtraSerializableProperty]
public string LabelFormat { get; set; }

VB.NET

<XtraSerializableProperty>
Public Property LabelFormat As String

Property Value

Type	Description
String	A string used to format chart label values.

Property Paths

You can access this nested property as listed below:

Object Type	Path to LabelFormat
ChartRangeControlClientDateTimeOptions	.RangeControlDateTimeGridOptions.LabelFormat
ChartRangeControlClientNumericOptions	.RangeControlNumericGridOptions.LabelFormat
GanttDiagram	.RangeControlNumericGridOptions.LabelFormat
SwiftPlotDiagram	.RangeControlNumericGridOptions.LabelFormat
XYDiagram	.RangeControlNumericGridOptions.LabelFormat
XYDiagram2D	.RangeControlNumericGridOptions.LabelFormat

Remarks

Use the LabelFormat property, to specify a custom format for the values displayed by chart client labels.

Example

This example demonstrates how the grid lines and grid snapping of the chart within the range control’s viewport can be customized at runtime.

To access the client options of the chart inside the range control’s viewport, use the RangeControl.ClientOptions property. In this example, the chart control contains data with date-time arguments, so this property returns an object of the ChartRangeControlClientDateTimeOptions type.

To access the grid properties (e.g., ChartRangeControlClientGridOptions.SnapSpacing, ChartRangeControlClientDateTimeGridOptions.SnapAlignment, ChartRangeControlClientGridOptions.GridSpacing and ChartRangeControlClientDateTimeGridOptions.GridAlignment) of the chart range control client, access the ChartRangeControlClientDateTimeGridOptions object using the ChartRangeControlClientDateTimeOptions.RangeControlDateTimeGridOptions property.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-grid-lines-grid-snapping-of-the-chart-range-control-client-t129232

Form1.cs

using System;
using System.Windows.Forms;
using DevExpress.XtraCharts;

namespace DateTimeChartRangeControlClient {
    public partial class Form1 : Form {

        const int daysForYear = 30;

        public Form1() {
            InitializeComponent();

            // Call the InitializeChart method. 
            InitializeChart();

            // Specify a Chart control as the Range control client. 
            rangeControl1.Client = chartControl1;

            // Access the date-time grid options of the chart range control client.
            var clientOptions = (ChartRangeControlClientDateTimeOptions)rangeControl1.ClientOptions;
            ChartRangeControlClientDateTimeGridOptions gridOptions = clientOptions.RangeControlDateTimeGridOptions;

            // Specify the manual grid mode of the chart range control client. 
            gridOptions.GridMode = ChartRangeControlClientGridMode.Manual;

            // Customize snap and grid properties of the chart range control client.            
            gridOptions.SnapOffset = 2;
            gridOptions.SnapSpacing = 7;
            gridOptions.SnapAlignment = DateTimeGridAlignment.Day;
            gridOptions.GridSpacing = 7;
            gridOptions.GridAlignment = DateTimeGridAlignment.Day;
            gridOptions.GridOffset = 1;

            // Format labels of the chart range control client.
            gridOptions.LabelFormat = "D";
        }

        void InitializeChart() {

            DateTime baseDate = new DateTime(2000, 1, 1);
            Random rnd = new Random();
            Series series = new Series("Series", ViewType.Bar);

            for (int dayCount = 0; dayCount < daysForYear; dayCount++) {
                DateTime argument = baseDate.AddDays(dayCount);
                double value = rnd.Next(50, 100);
                var seriesPoint = new SeriesPoint(argument, value);
                series.Points.Add(seriesPoint);
            }
            chartControl1.Series.Add(series);
        }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraCharts

Namespace DateTimeChartRangeControlClient
    Partial Public Class Form1
        Inherits Form

        Private Const daysForYear As Integer = 30

        Public Sub New()
            InitializeComponent()

            ' Call the InitializeChart method. 
            InitializeChart()

            ' Specify a Chart control as the Range control client. 
            rangeControl1.Client = chartControl1

            ' Access the date-time grid options of the chart range control client.
            Dim clientOptions = CType(rangeControl1.ClientOptions, ChartRangeControlClientDateTimeOptions)
            Dim gridOptions As ChartRangeControlClientDateTimeGridOptions = clientOptions.RangeControlDateTimeGridOptions

            ' Specify the manual grid mode of the chart range control client. 
            gridOptions.GridMode = ChartRangeControlClientGridMode.Manual

            ' Customize snap and grid properties of the chart range control client.            
            gridOptions.SnapOffset = 2
            gridOptions.SnapSpacing = 7
            gridOptions.SnapAlignment = DateTimeGridAlignment.Day
            gridOptions.GridSpacing = 7
            gridOptions.GridAlignment = DateTimeGridAlignment.Day
            gridOptions.GridOffset = 1

            ' Format labels of the chart range control client.
            gridOptions.LabelFormat = "D"
        End Sub

        Private Sub InitializeChart()

            Dim baseDate As New DateTime(2000, 1, 1)
            Dim rnd As New Random()
            Dim series As New Series("Series", ViewType.Bar)

            For dayCount As Integer = 0 To daysForYear - 1
                Dim argument As DateTime = baseDate.AddDays(dayCount)
                Dim value As Double = rnd.Next(50, 100)
                Dim seriesPoint = New SeriesPoint(argument, value)
                series.Points.Add(seriesPoint)
            Next dayCount
            chartControl1.Series.Add(series)
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the LabelFormat 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#

how-to-customize-grid-lines-grid-snapping-of-the-chart-range-control-client-t129232/CS/Form1.cs#L35

    // Format labels of the chart range control client.
    gridOptions.LabelFormat = "D";
}