PivotGridFieldBase.Caption Property

Gets or sets the field’s display caption.

Namespace: DevExpress.XtraPivotGrid

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

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.Win.Navigation

Declaration

C#

[DefaultValue("")]
public string Caption { get; set; }

VB.NET

<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.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Caption 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#

web-forms-pivot-grid-group-field-values-into-the-specified-intervals/CS/CustomGroupInterval/Default.aspx.cs#L38

ASPxPivotGrid1.Fields[0].Visible = true;
ASPxPivotGrid1.Fields[0].Caption = "Product Group";
ASPxPivotGrid1.Fields[0].GroupInterval = DevExpress.XtraPivotGrid.PivotGroupInterval.Custom;

winforms-pivot-change-summarydisplaytype-in-context-menu/CS/WindowsApplication34/Form1.cs#L26

fieldYear.DataBinding = new DataSourceColumnBinding("Date", PivotGroupInterval.DateYear);
fieldYear.Caption = fieldYear.Name;
pivotGridControl1.Fields.AddRange(new PivotGridField[] { fieldYear });

winforms-pivot-grid-hide-the-grand-total-column-and-text-labels/CS/RemoveGridLinesExample/Form1.cs#L35

fieldYear.Name = "FieldYear";
fieldYear.Caption = fieldYear.Name;
PivotGridField fieldMonth = new PivotGridField();

web-forms-pivot-grid-customize-cell-appearance-via-templates/CS/ASPxPivotGrid_CellTemplates/Default.aspx.cs#L19

if (field != null && field.Caption == "Percents") {
    int value = Convert.ToInt32(Convert.ToDecimal(

web-forms-pivot-grid-change-summary-display-mode/CS/SummaryDisplayMode/Default.aspx.cs#L172

    SummaryDisplayTypeDataField.SummaryDisplayType = (PivotSummaryDisplayType)Enum.Parse(typeof(PivotSummaryDisplayType), ddlSummaryDisplayType.SelectedItem.Text);
    SummaryDisplayTypeDataField.Caption = string.Format("{0}", SummaryDisplayTypeDataField.SummaryDisplayType);
}

VB.NET

web-forms-pivot-grid-group-field-values-into-the-specified-intervals/VB/CustomGroupInterval/Default.aspx.vb#L45

ASPxPivotGrid1.Fields(0).Visible = True
ASPxPivotGrid1.Fields(0).Caption = "Product Group"
ASPxPivotGrid1.Fields(0).GroupInterval = DevExpress.XtraPivotGrid.PivotGroupInterval.Custom

winforms-pivot-change-summarydisplaytype-in-context-menu/VB/WindowsApplication34/Form1.vb#L28

fieldYear.Name = "FieldYear"
fieldYear.Caption = fieldYear.Name
fieldYear.GroupInterval = PivotGroupInterval.DateYear

winforms-pivot-grid-hide-the-grand-total-column-and-text-labels/VB/RemoveGridLinesExample/Form1.vb#L41

fieldYear.Name = "FieldYear"
fieldYear.Caption = fieldYear.Name
Dim fieldMonth As New PivotGridField()

web-forms-pivot-grid-customize-cell-appearance-via-templates/VB/ASPxPivotGrid_CellTemplates/Default.aspx.vb#L21

If field IsNot Nothing AndAlso field.Caption = "Percents" Then
    Dim value As Integer = Convert.ToInt32(Convert.ToDecimal(templateContainer.Value) * 350)

web-forms-pivot-grid-change-summary-display-mode/VB/SummaryDisplayMode/Default.aspx.vb#L191

    SummaryDisplayTypeDataField.SummaryDisplayType = DirectCast(System.Enum.Parse(GetType(PivotSummaryDisplayType), ddlSummaryDisplayType.SelectedItem.Text), PivotSummaryDisplayType)
    SummaryDisplayTypeDataField.Caption = String.Format("{0}", SummaryDisplayTypeDataField.SummaryDisplayType)
End Sub