CustomLegendItem.Text Property

Gets or sets the text the custom legend item displays.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v18.2.dll

Declaration

C#

[XtraChartsLocalizableCategory(XtraChartsCategory.Data)]
[XtraSerializableProperty]
public string Text { get; set; }

VB.NET

<XtraChartsLocalizableCategory(XtraChartsCategory.Data)>
<XtraSerializableProperty>
Public Property Text As String

Property Value

Type	Description
String	A String that specifies the legend item text.

Example

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

• Create a CustomLegendItem object and add it to the Legend.CustomItems collection.
• Use the MarkerImage and Text properties to specify the custom item’s content.
• The Legend.ItemVisibilityMode property allows you to define whether to show custom items and auto-generated items together.

The following code adds a custom legend item with an image and text.

C#

private void Form1_Load(object sender, EventArgs e) {
    double total = CalculateTotal(chartControl.Series[0]);

    CustomLegendItem customLegendItem = new CustomLegendItem();
    customLegendItem.MarkerImage.Image = new Bitmap("..\\..\\Images\\sum-icon.png");
    customLegendItem.MarkerImageSizeMode = ChartImageSizeMode.Zoom;
    customLegendItem.Text = string.Format("Total: ${0}M", total);            
    chartControl.Legend.CustomItems.Add(customLegendItem);
    chartControl.Legend.ItemVisibilityMode = LegendItemVisibilityMode.AutoGeneratedAndCustom;
    chartControl.Legend.Direction = LegendDirection.TopToBottom;
}
public Double CalculateTotal (Series series) {
    double total = 0;
    foreach(SeriesPoint point in series.Points) {
        total += point.Values[0];
    }
    return total;
}

VB.NET

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
    Dim total As Double = CalculateTotal(chartControl.Series(0))
    Dim customLegendItem As CustomLegendItem = New CustomLegendItem
    customLegendItem.MarkerImage.Image = New Bitmap("..\..\Images\sum-icon.png")
    customLegendItem.MarkerImageSizeMode = ChartImageSizeMode.Zoom
    customLegendItem.Text = String.Format("Total: ${0}M", total)
    chartControl.Legend.CustomItems.Add(customLegendItem)
    chartControl.Legend.ItemVisibilityMode = LegendItemVisibilityMode.AutoGeneratedAndCustom
    chartControl.Legend.Direction = LegendDirection.TopToBottom
End Sub

Public Function CalculateTotal(ByVal series As Series) As Double
    Dim total As Double = 0
    For Each point As SeriesPoint In series.Points
        total = (total + point.Values(0))
    Next
    Return total
End Function

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Text 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.

C#

how-to-add-a-custom-item-to-a-legend-t374906/CS/CustomLegendItemSample/Form1.cs#L18

// Specify its text and marker.
item.Text = "Custom Legend Item";
Bitmap bitmap = new Bitmap("Image\\DXLogo_16x16.png");

VB.NET

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

' Specify its text and marker.
item.Text = "Custom Legend Item"
Dim bitmap As New Bitmap("Image\DXLogo_16x16.png")