Tag

PivotGridFieldBase.Caption Property

Gets or sets the field's display caption.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v19.2.Core.dll

Declaration

[DefaultValue("")]
public string Caption { get; set; }
<DefaultValue("")>
Public Property Caption As String

Property Value

Type Default Description
String

String.Empty

A string specifying the field's display caption.

Remarks

Use the Caption property to specify the text displayed within the field's header.

If the Caption property is set to an empty string the field's header will display the value of the PivotGridFieldBase.FieldName property. If the PivotGridFieldBase.FieldName property is set to an empty string, the field's header will display the value of the field's Name property.

If the PivotGridFieldOptions.ShowSummaryTypeName property is enabled, the field's summary type enclosed in round brackets is appended to the field's Caption. To get the actual text displayed within a field's header, use the PivotGridFieldBase.HeaderDisplayText property.

See Also