LegendBase.CustomItems Property

Returns a collection of custom legend items of the legend.

Namespace: DevExpress.Xpf.Charts

Assembly: DevExpress.Xpf.Charts.v24.2.dll

NuGet Package: DevExpress.Wpf.Charts

Declaration

C#

public CustomLegendItemCollection CustomItems { get; }

VB.NET

Public ReadOnly Property CustomItems As CustomLegendItemCollection

Property Value

Type	Description
CustomLegendItemCollection	A collection of CustomLegendItem objects.

Example

To add a custom legend item to a legend, create a new instance of the CustomLegendItem class and add it to the LegendBase.CustomItems collection. Then, configure the custom item, for example, using the CustomLegendItem.Text property to set the item’s text and the CustomLegendItem.MarkerTemplate property to set the item’s marker.

View Example

MainWindow.xaml

<Window.Resources>
    <DataTemplate x:Key="markerTemplate">
        <Image Source="Images/DXLogo.png"/>
    </DataTemplate>
</Window.Resources>
        <dxc:ChartControl.Legend>
            <dxc:Legend ItemVisibilityMode="AutoGeneratedAndCustom">
                <dxc:Legend.CustomItems>
                    <dxc:CustomLegendItem MarkerBrush="#FFFF8000" 
                                          MarkerTemplate="{Binding Source={StaticResource markerTemplate}}" 
                                          Text="Powered by DevExpress"/>
                </dxc:Legend.CustomItems>
            </dxc:Legend>
        </dxc:ChartControl.Legend>

Related GitHub Examples

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

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.

XAML

how-to-add-a-custom-legend-item-to-a-legend-t377606/CS/CustomLegendItemSample/MainWindow.xaml#L25

<dxc:Legend ItemVisibilityMode="AutoGeneratedAndCustom">
    <dxc:Legend.CustomItems>
        <dxc:CustomLegendItem MarkerBrush="#FFFF8000"