GridColumn.SummaryText Property

Gets the summary text displayed within the View footer cell located under this column.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

[Browsable(false)]
public string SummaryText { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property SummaryText As String

Property Value

Type	Description
String	A String value which is the formatted textual representation of this column’s total summary value.

Remarks

You can specify the total summary to be calculated for a particular column using the column’s GridColumn.SummaryItem property. This property provides access to the GridSummaryItem object whose settings specify the aggregate function used, the field whose values are used for calculation and the calculated value formatting. The calculated value, formatted as specified by the summary item object, is displayed within the View footer cell located under the column. This formatted summary value can be obtained via the column’s SummaryText property.

Please refer to the Working with Summaries in Code. Custom Summaries topic for additional information.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SummaryText 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#

how-to-show-multiple-summary-values-under-the-same-column-e651/CS/CS/Form1.cs#L197

e.Info.Bounds = new Rectangle(e.Info.Bounds.Left, e.Info.Bounds.Bottom + 1, e.Info.Bounds.Width, e.Info.Bounds.Height);
e.Info.DisplayText = view.Columns["Dummy"].SummaryText;
e.Painter.DrawObject(e.Info);

VB.NET

how-to-show-multiple-summary-values-under-the-same-column-e651/VB/CS/Form1.vb#L184

e.Info.Bounds = New Rectangle(e.Info.Bounds.Left, e.Info.Bounds.Bottom + 1, e.Info.Bounds.Width, e.Info.Bounds.Height)
e.Info.DisplayText = view.Columns("Dummy").SummaryText
e.Painter.DrawObject(e.Info)