Skip to main content
All docs
V25.1
  • LegendBase.CustomItems Property

    Returns the custom legend item collection.

    Namespace: DevExpress.XtraCharts

    Assembly: DevExpress.XtraCharts.v25.1.dll

    NuGet Package: DevExpress.Charts

    #Declaration

    [PersistenceMode(PersistenceMode.InnerProperty)]
    [XtraChartsLocalizableCategory(XtraChartsCategory.Elements)]
    public CustomLegendItemCollection CustomItems { get; }

    #Property Value

    Type Description
    CustomLegendItemCollection

    A collection of CustomLegendItem objects.

    #Example

    This example demonstrates how to add a custom legend item to a legend.

    View Example

    Custom Legend Item

    Create a CustomLegendItem object and add it to the CustomItems collection. Use the following properties to configure the custom item:

    CustomLegendItem.MarkerImage
    Returns the custom legend item’s marker image.
    CustomLegendItem.Text
    Gets or sets the text the custom legend item displays.

    To show custom and automatically generated legend items, set the LegendBase.ItemVisibilityMode to AutoGeneratedAndCustom.

    using DevExpress.Drawing;
    using DevExpress.XtraCharts;
    using System;
    using System.IO;
    using System.Windows.Forms;
    
    namespace CustomLegendItemSample {
        public partial class Form1 : Form {
            public Form1() {
                InitializeComponent();
            }
            private void Form1_Load(object sender, EventArgs e) {
                #region #CustomLegendItems
                // Create a new custom item.
                CustomLegendItem item = new CustomLegendItem();
                chart.Legend.CustomItems.Add(item);
                // Specify its text and marker.
                item.Text = "Custom Legend Item";
                FileStream outfile = new FileStream("Image\\DXLogo_16x16.png", FileMode.Open);
                DXImage image = DXImage.FromStream(outfile);
                item.MarkerImage.DXImage = image;
    
                // Set a value indicating that both autogenerated and custom items are displayed.
                chart.Legend.ItemVisibilityMode = LegendItemVisibilityMode.AutoGeneratedAndCustom;
                #endregion #CustomLegendItems
            }
        }
    }
    
    See Also