CrosshairOptions.GroupHeaderPattern Property

Gets or sets a string representing the pattern specifying the group header text to be displayed within the crosshair label.

Namespace: DevExpress.Xpf.Charts

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

Declaration

C#

[XtraSerializableProperty]
public string GroupHeaderPattern { get; set; }

VB.NET

<XtraSerializableProperty>
Public Property GroupHeaderPattern As String

Property Value

Type	Description
String	A String representing the group header's pattern.

Property Paths

You can access the CrosshairOptions.GroupHeaderPattern property from the following objects:

Object Type	Path to GroupHeaderPattern
ChartControl	.CrosshairOptions.GroupHeaderPattern

Remarks

The group header's pattern allows you to specify a string in addition to either the "{A}" placeholder, if the CrosshairOptions.SnapMode property is set to NearestArgument or the "{V}" placeholder for the NearestValue snap mode.

NOTE

A crosshair group header is not displayed on the crosshair label when the CrosshairOptions.CrosshairLabelMode property is set to either CrosshairLabelMode.ShowForEachSeries or CrosshairLabelMode.ShowForNearestSeries modes.

The following image shows this property in action with the "Year: {A}" pattern.

For more information, see the Crosshair Cursor topic.

Examples

This example demonstrates changing a text displayed in crosshair labels using crosshair format patterns.

To accomplish this, it is necessary to specify a string which will represent a displayed pattern within a crosshair label using the CrosshairAxisLabelOptions.Pattern, XYSeries2D.CrosshairLabelPattern, and CrosshairOptions.GroupHeaderPattern properties.

In addition, standard and custom format specifiers are used together with the placeholders to format numeric and date/time values (e.g., {A:F0}).

To learn more on a crosshair cursor, see the Crosshair Cursor topic.