AxisLabelItemBase.Text Property

Gets or sets the text for an axis label item.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v23.2.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[XtraChartsLocalizableCategory(XtraChartsCategory.Misc)]
public string Text { get; set; }

VB.NET

<XtraChartsLocalizableCategory(XtraChartsCategory.Misc)>
Public Property Text As String

Property Value

Type	Description
String	A String that specifies the text for an axis label item.

Remarks

An axis label item is the specific instance of the AxisLabelItem class, obtained in the ChartControl.CustomDrawAxisLabel (or WebChartControl.CustomDrawAxisLabel) event handler.

For more information, refer to Axis Labels.

Example

Apart from the capability to customize the overall appearance of axis labels, you can obtain individual axis labels at runtime. Then, it’s possible to apply all the options available for axis labels to them, individually. For example, based on some criteria (e.g. an axis value threshold), you can apply different formatting to axis labels.

For this, the special ChartControl.CustomDrawAxisLabel event is introduced. Handle it to obtain axis labels.

Note

For the WebChartControl you should handle its WebChartControl.CustomDrawSeries event to implement this task.

The following code demonstrates one possible implementation of this capability.

C#

private void chartControl1_CustomDrawAxisLabel(object sender, CustomDrawAxisLabelEventArgs e) {
    AxisBase axis = e.Item.Axis;
    if (axis is AxisY || axis is AxisY3D || axis is RadarAxisY) {
        double axisValue = (double)e.Item.AxisValue;
        if (axisValue < 0) {
            e.Item.TextColor = Color.Red;
        }
        else if (axisValue > 0) {
            e.Item.Text = "+" + e.Item.Text;
            e.Item.TextColor = Color.Green;
        }
        else if (axisValue == 0) {
            e.Item.Text = "Zero";
        }
    }
}

VB.NET

Private Sub chartControl1_CustomDrawAxisLabel(sender As Object, e As CustomDrawAxisLabelEventArgs)
   Dim axis As AxisBase = e.Item.Axis
   If TypeOf axis Is AxisY Or TypeOf axis Is AxisY3D Or TypeOf axis Is RadarAxisY Then
      Dim axisValue As Double = CDbl(e.Item.AxisValue)
      If axisValue < 0 Then
         e.Item.TextColor = Color.Red
      Else
         If axisValue > 0 Then
            e.Item.Text = "+" + e.Item.Text
            e.Item.TextColor = Color.Green
         Else
            If axisValue = 0 Then
               e.Item.Text = "Zero"
            End If
         End If
      End If
   End If
End Sub

Related GitHub Examples

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

winforms-dashboards-how-to-use-a-custom-format-for-axis-labels-in-the-chart-item/CS/DesignerSample/Form1.cs#L46

{
    e.Item.Text = "$" + e.Item.Text;
}

winforms-charts-how-to-individually-customize-axis-labels/CS/CustomAxisLabels/Form1.cs#L21

// Customize the axis label's text and color.
e.Item.Text = "+" + e.Item.Text;
e.Item.TextColor = Color.Green;

VB.NET

winforms-dashboards-how-to-use-a-custom-format-for-axis-labels-in-the-chart-item/VB/DesignerSample/Form1.vb#L38

If TypeOf e.Item.Axis Is SecondaryAxisY Then
    e.Item.Text = "$" & e.Item.Text
End If

winforms-charts-how-to-individually-customize-axis-labels/VB/CustomAxisLabels/Form1.vb#L24

' Customize the axis label's text and color.
e.Item.Text = "+" & e.Item.Text
e.Item.TextColor = Color.Green