CustomLegendItem Class

An individual custom legend item.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v18.1.dll

Declaration

C#

[TypeConverter(typeof(CustomLegendItemTypeConverter))]
public class CustomLegendItem :
    ChartElementNamed,
    ILegendItemData,
    ILegendItem

VB.NET

<TypeConverter(GetType(CustomLegendItemTypeConverter))>
Public Class CustomLegendItem
    Inherits ChartElementNamed
    Implements ILegendItemData,
               ILegendItem

Related API Members

The following members accept/return CustomLegendItem objects:

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

Remarks

The CustomLegendItem class contains the settings that define the functionality of a custom item within a legend.

In addition to the settings inherited from the base ChartElementNamed class, the CustomLegendItem class implements properties that allow you to specify the text used to display an item (the CustomLegendItem.Text property), color (CustomLegendItem.MarkerColor) or image (CustomLegendItem.MarkerImage) used to display an item’s marker and control the item elements visibility (CustomLegendItem.TextVisible and CustomLegendItem.MarkerVisible).

Custom items associated with a particular legend are contained within the Legend.CustomItems collection which is represented by an object of the CustomLegendItemCollection class. A particular CustomLegendItem object can be accessed within the collection either using indexer notation or by its name (see the CustomLegendItemCollection.Item property).

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomLegendItem class.

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-add-a-custom-item-to-a-legend-t374906/CS/CustomLegendItemSample/Form1.cs#L15

// Create a new custom item.
CustomLegendItem item = new CustomLegendItem();
chart.Legend.CustomItems.Add(item);

VB.NET

how-to-add-a-custom-item-to-a-legend-t374906/VB/CustomLegendItemSample/Form1.vb#L17

' Create a new custom item.
Dim item As New CustomLegendItem()
chart.Legend.CustomItems.Add(item)

Inheritance

Object

ChartElement

ChartElementNamed

CustomLegendItem