TreeListSummaryItem.DisplayFormat Property

Gets or sets the format of the summary value.

Namespace: DevExpress.Web.ASPxTreeList

Assembly: DevExpress.Web.ASPxTreeList.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

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

VB.NET

<DefaultValue("")>
Public Property DisplayFormat As String

Property Value

Type	Default	Description
String	String.Empty	A String value that specifies the summary value’s display format. An empty string to display the summary value using default formatting.

Remarks

Use the DisplayFormat property to apply formatting to the summary value, and add any static text to its textual representation. The general pattern for setting the DisplayFormat property value is shown below:

<custom static text>{0<:format specifier<precision specifier> >}<custom static text>

Here, the ‘{0}’ character sequence is the summary value’s placeholder. The format specifier sets the formatting type (currency, scientific, etc). The precision specifier sets the number of characters to be displayed after the decimal point.

For instance, if displaying currency values within a column, set the DisplayFormat property to ‘Total: {0:c2}’. If the summary value is 123, the formatted summary value representation will be ‘Total: $123.00‘.

For details on using format specifiers, see Format Specifiers.

Note

Setting the DisplayFormat property to an empty string applies default summary value formatting.