CustomAxisLabelCollection.Add(CustomAxisLabel) Method

Appends the specified CustomAxisLabel object to the current collection.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v20.2.dll

Declaration

public int Add(
    CustomAxisLabel label
)
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.

Examples

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

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
    }
}
See Also