CustomAxisLabelCollection.Add(CustomAxisLabel) Method

Appends the specified CustomAxisLabel object to the current collection.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v18.2.dll

Declaration

C#

public int Add(
    CustomAxisLabel label
)

VB.NET

Public Function Add(
    label As CustomAxisLabel
) As Integer

Parameters

Name	Type	Description
label	CustomAxisLabel	A CustomAxisLabel object to append to the collection.

Returns

Type	Description
Int32	An integer value indicating the position at which the new element was inserted.

Remarks

This method adds a CustomAxisLabel object to the end of the collection.

Example

This example demonstrates how custom axis labels can be created and customized at runtime.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-create-custom-axis-labels-e1359

Form1.cs

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

namespace CustomAxisLabels {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }

        #region #CustomLabels
        private void Form1_Load(object sender, EventArgs e) {
            // Cast the chart's diagram to the XYDiagram type, to access its axes.
            XYDiagram diagram = chartControl.Diagram as XYDiagram;
            if(diagram == null) return;

            AxisX axisX = diagram.AxisX;
            // Add a custom label to the X-axis.
            axisX.CustomLabels.Add(new CustomAxisLabel(name: "State of Michigan", value: "Michigan") {
                TextColor = Color.FromArgb(255, 74, 74, 74),
                BackColor = Color.FromArgb(255, 225, 225, 225)
            });
            // Make auto-generated and custom labels visible at the same time.
            axisX.LabelVisibilityMode = AxisLabelVisibilityMode.AutoGeneratedAndCustom;
        }
        #endregion
    }
}

Form1.vb

Imports System
Imports System.Drawing
Imports System.Windows.Forms
Imports DevExpress.XtraCharts

Namespace CustomAxisLabels
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
        End Sub

        #Region "#CustomLabels"
        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load
            ' Cast the chart's diagram to the XYDiagram type, to access its axes.
            Dim diagram As XYDiagram = TryCast(chartControl.Diagram, XYDiagram)
            If diagram Is Nothing Then
                Return
            End If

            Dim axisX As AxisX = diagram.AxisX
            ' Add a custom label to the X-axis.
            axisX.CustomLabels.Add(New CustomAxisLabel(name:= "State of Michigan", value:= "Michigan") With { _
                .TextColor = Color.FromArgb(255, 74, 74, 74), _
                .BackColor = Color.FromArgb(255, 225, 225, 225) _
            })
            ' Make auto-generated and custom labels visible at the same time.
            axisX.LabelVisibilityMode = AxisLabelVisibilityMode.AutoGeneratedAndCustom
        End Sub
        #End Region
    End Class
End Namespace

Related GitHub Examples

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

how-to-create-custom-axis-labels-e1359/CS/CustomAxisLabels/Form1.cs#L20

// Add a custom label to the X-axis.
axisX.CustomLabels.Add(new CustomAxisLabel(name: "State of Michigan", value: "Michigan") {
    TextColor = Color.FromArgb(255, 74, 74, 74),

VB.NET

how-to-create-custom-axis-labels-e1359/VB/CustomAxisLabels/Form1.vb#L22

' Add a custom label to the X-axis.
axisX.CustomLabels.Add(New CustomAxisLabel(name:="State of Michigan", value:="Michigan") With {.TextColor = Color.FromArgb(255, 74, 74, 74), .BackColor = Color.FromArgb(255, 225, 225, 225)})
' Make auto-generated and custom labels visible at the same time.