Format Property (SeriesLegend)

Defines the format string for the legend texts.

Syntax

Visual Basic
C#

'Declaration
 
<CategoryAttribute("General")>
<DescriptionAttribute("Defines the information which must be displayed for each data point if the Mode is set to DataPoints.")>
Public Property Format As String

'Usage
 
Dim instance As SeriesLegend
Dim value As String
 
instance.Format = value
 
value = instance.Format

[Category("General")]
[Description("Defines the information which must be displayed for each data point if the Mode is set to DataPoints.")]
public string Format {get; set;}

Remarks

This property is taken into account if the Mode property is set to DataPoints.

Example

The following code displays the index and label of a bar series data points in the legend.

Visual Basic

bar.Legend.Mode = SeriesLegendMode.DataPoints
bar.Legend.Format = "&lt;label&gt; &lt;index&gt;"

bar.Legend.Mode = SeriesLegendMode.DataPoints;
bar.Legend.Format = "&lt;label&gt; &lt;index&gt;";

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

SeriesLegend Class
SeriesLegend Members