TreeListMenuItemClickEventArgs.SummaryFormat Property

Gets or sets the format of summary value displayed for the column.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v24.2.dll

Declaration

C#

public string SummaryFormat { get; set; }

VB.NET

Public Property SummaryFormat As String

Property Value

Type	Description
String	The format string applied to the column’s summary value.

Remarks

the SummaryFormat property returns an empty string if a column header’s menu item or the All Nodes item of the summary footer menu has been clicked. If the None menu item of either summary footer or row footer menu has been clicked, it returns the string “none“. Assignment to the SummaryFormat property in such cases has no effect.

In instances other than those listed above (when changing the summary type via a context menu), the SummaryFormat property returns the format string which is about to be applied to the displayed summary value. Assign a custom format string to this property to implement your own formatting of the calculated summary value. This feature is very useful since changing the summary type via a context menu sets the summary value format to its default.

Note: initially, summary value formats are specified via the TreeListColumn.SummaryFooterStrFormat and TreeListColumn.RowFooterSummaryStrFormat properties. Please refer to their description for details on constructing format strings.