CustomLegendItem Class

An individual custom legend item.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v23.2.dll

NuGet Package: DevExpress.Charts

Declaration

C#

public class CustomLegendItem :
    ChartElementNamed,
    ILegendItemData,
    ILegendItem,
    IDisposable,
    IXtraPartlyDeserializable,
    ISupportID,
    ISupportInitialize

VB.NET

Public Class CustomLegendItem
    Inherits ChartElementNamed
    Implements ILegendItemData,
               ILegendItem,
               IDisposable,
               IXtraPartlyDeserializable,
               ISupportID,
               ISupportInitialize

Related API Members

The following members return CustomLegendItem objects:

• ChartHitInfoBase.CustomLegendItem
• CustomLegendItemCollection.Item[Int32]
• CustomLegendItemCollection.Item[String]

Remarks

Use the Text property to specify the custom item’s text. To change the item marker appearance, use MarkerColor or MarkerImage properties. The CustomLegendItem.TextVisible and CustomLegendItem.MarkerVisible properties allow you control the item elements’ visibility.

The Legend.CustomItems property provides access to the CustomLegendItemCollection collection that stores custom items. A particular CustomLegendItem object can be accessed within the collection either using indexer notation or by its name (see the CustomLegendItemCollection.Item property).

Example

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

View Example

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.

Form1.cs

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

Form1.vb

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

Namespace CustomLegendItemSample

    Public Partial Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
#Region "#CustomLegendItems"
            ' Create a new custom item.
            Dim item As CustomLegendItem = New CustomLegendItem()
            chart.Legend.CustomItems.Add(item)
            ' Specify its text and marker.
            item.Text = "Custom Legend Item"
            Dim outfile As FileStream = New FileStream("Image\DXLogo_16x16.png", FileMode.Open)
            Dim image As DXImage = DXImage.FromStream(outfile)
            item.MarkerImage.DXImage = image
            ' Set a value indicating that both autogenerated and custom items are displayed.
            chart.Legend.ItemVisibilityMode = LegendItemVisibilityMode.AutoGeneratedAndCustom
#End Region  ' #CustomLegendItems
        End Sub
    End Class
End Namespace

Inheritance

Object

ChartElement

ChartElementNamed

CustomLegendItem