SeriesNameTemplate Class

Contains settings that define the common prefix and postfix for the names of data bound series.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v20.1.dll

Declaration

public class SeriesNameTemplate :
    ChartElement
Public Class SeriesNameTemplate
    Inherits ChartElement

Related API Members

The following members accept/return SeriesNameTemplate objects:

Library Related API Members
WinForms Controls ChartControl.SeriesNameTemplate
SnapChart.SeriesNameTemplate
ASP.NET Controls and MVC Extensions ChartControlSettings.SeriesNameTemplate
WebChartControl.SeriesNameTemplate
Reporting XRChart.SeriesNameTemplate

Remarks

The SeriesNameTemplate class serves as a naming template for series which are not present in the ChartControl.Series collection but are bound to their data at the chart control level (in particular, via the ChartControl.DataSource, ChartControl.SeriesDataMember and both the SeriesBase.ArgumentDataMember and SeriesBase.ValueDataMembers properties).

The SeriesNameTemplate class exposes two properties (SeriesNameTemplate.BeginText and SeriesNameTemplate.EndText) that define the common prefixes and postfixes for the names of data bound series. The series names which these prefix and postfix are added to are taken by each series from the data field defined by the ChartControl.SeriesDataMember property.

Examples

The following example demonstrates how to bind a chart to data at runtime using series templates. It uses the same approach as the design-time example, but another data table is generated in this code to simplify the example. For this example to work correctly, don't forget to include all necessary assemblies to the References list of your project.

using System;
using System.Data;
using System.Windows.Forms;
using DevExpress.XtraCharts;
// ...

namespace BindUsingTemplatesRuntimeCS {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }

        private DataTable CreateChartData() {
            // Create an empty table.
            DataTable table = new DataTable("Table1");

            // Add three columns to the table.
            table.Columns.Add("Month", typeof(String));
            table.Columns.Add("Section", typeof(String));
            table.Columns.Add("Value", typeof(Int32));

            // Add data rows to the table.
            table.Rows.Add(new object[] { "Jan", "Section1", 10 });
            table.Rows.Add(new object[] { "Jan", "Section2", 20 });
            table.Rows.Add(new object[] { "Feb", "Section1", 20 });
            table.Rows.Add(new object[] { "Feb", "Section2", 30 });
            table.Rows.Add(new object[] { "March", "Section1", 15 });
            table.Rows.Add(new object[] { "March", "Section2", 25 });

            return table;
        }

        private void Form1_Load(object sender, EventArgs e) {
            // Create a chart.
            ChartControl chart = new ChartControl();

            // Generate a data table and bind the chart to it.
            chart.DataSource = CreateChartData();

            // Specify data members to bind the chart's series template.
            chart.SeriesDataMember = "Month";
            chart.SeriesTemplate.ArgumentDataMember = "Section";
            chart.SeriesTemplate.ValueDataMembers.AddRange(new string[] {"Value"});

            // Specify the template's series view.
            chart.SeriesTemplate.View = new StackedBarSeriesView();

            // Specify the template's name prefix.
            chart.SeriesNameTemplate.BeginText = "Month: ";

            // Dock the chart into its parent, and add it to the current form.
            chart.Dock = DockStyle.Fill;
            this.Controls.Add(chart);
        }
    }
}

Inheritance

Object
ChartElement
SeriesNameTemplate
See Also