CustomDrawFooterCellEventArgs.Text Property

Gets or sets the text intended to be displayed within the painted footer cell.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v20.1.dll

Declaration

public string Text { get; set; }
Public Property Text As String

Property Value

Type Description
String

A string value specifying the text to be displayed within the painted footer cell (a string representation of the resulting summary value). An empty string if summary is not applied to a column whose footer cell is being painted.

Remarks

The TreeList control gives you the ability to calculate summaries for column values. Use the TreeListColumn.SummaryFooter property of a column to specify the type of aggregate function calculated for column values. The resulting summary value is displayed within the corresponding footer cell.

Use the Text event argument in a TreeList.CustomDrawFooterCell event handler to complete the following tasks:

  • Read the Text property to obtain the resulting summary value. Paint the obtained value within the cell using custom draw. Note that the TreeList.CustomDrawFooterCell event fires for each column regardless of whether summary is applied to it. Thus you must check the Text property value to avoid painting empty cells. Set the CustomDrawEventArgs.Handled property of the event parameter to false to prohibit cell custom painting.
  • Assign a value to the Text property and leave the CustomDrawEventArgs.Handled property set to false. This will result in default cell painting with a custom value in it.
See Also