A newer version of this page is available. Switch to the current version.

TreeList.CustomDrawRowFooterCell Event

Provides the ability to perform custom painting of row footer cells.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v19.2.dll

Declaration

[DXCategory("CustomDraw")]
public event CustomDrawRowFooterCellEventHandler CustomDrawRowFooterCell

Event Data

The CustomDrawRowFooterCell event's data class is CustomDrawRowFooterCellEventArgs. The following properties provide information specific to this event:

Property Description
Appearance Gets the painted element's appearance settings. Inherited from CustomDrawEventArgs.
Bounds Gets the painted element's bounding rectangle. Inherited from CustomDrawEventArgs.
Cache Gets an object specifying the storage for the most used pens, fonts and brushes. Inherited from CustomDrawEventArgs.
CellInfo Gets an object containing information about the painted element. Inherited from CustomDrawFooterCellEventArgs.
Column Gets a column whose footer cell is painted. Inherited from CustomDrawFooterCellEventArgs.
Graphics Gets an object used to paint. Inherited from CustomDrawEventArgs.
Handled Gets or sets a value specifying whether an event was handled and that the default element painting is therefore not required. Inherited from CustomDrawEventArgs.
IsRightToLeft Gets a value indicating whether the TreeList's elements are aligned to support locales using right-to-left fonts. Inherited from CustomDrawEventArgs.
ItemType Gets the type of summary whose value is displayed within the painted cell. Inherited from CustomDrawFooterCellEventArgs.
Node Gets the node for whose children the row footer is displayed.
ObjectArgs Gets an object containing information about the painted element. Inherited from CustomDrawEventArgs.
Painter Gets the painter object that provides the default element's painting mechanism. Inherited from CustomDrawEventArgs.
Text Gets or sets the text intended to be displayed within the painted footer cell. Inherited from CustomDrawFooterCellEventArgs.

The event data class exposes the following methods:

Method Description
DefaultDraw() Performs default painting of an element. Inherited from CustomDrawEventArgs.

Remarks

The CustomDrawRowFooterCell event fires for each column regardless of whether row summary is being calculated for it. Use the CustomDrawFooterCellEventArgs.Text property of the event parameter to determine the value which is about to be displayed.

Handle the TreeList.CustomDrawRowFooter event to perform custom painting of row footers.

See the Custom Draw Scenarios topic for information on using custom draw events.

IMPORTANT

Never change cell values or modify the control's layout on this event, or any other event designed to tune the control's appearance. Any action that causes a layout update can cause the control to malfunction.

Examples

The following sample code handles the TreeList.CustomDrawRowFooter and TreeList.CustomDrawRowFooterCell events. These are used to perform custom painting of row footers and cells within it. Note that only cells containing values are painted.

CustomDraw - RowFooter

using System.Drawing;
using System.Drawing.Drawing2D;
using DevExpress.XtraTreeList;

private void treeList1_CustomDrawRowFooter(object sender, CustomDrawRowFooterEventArgs e) {
    // filling background with a linear gradient brush
    Brush backBrush = e.Cache.GetGradientBrush(e.Bounds, Color.Cornsilk,
      Color.LightSkyBlue, LinearGradientMode.Vertical);
    e.Cache.FillRectangle(backBrush, e.Bounds);
    // painting borders
    e.Cache.DrawRectangle(e.Cache.GetPen(Color.LightGray), e.Bounds);

    // prohibiting default painting
    e.Handled = true;
}

private void treeList1_CustomDrawRowFooterCell(object sender, 
CustomDrawRowFooterCellEventArgs e) {
    // cells which don't contain values are not painted
    if (e.Text == string.Empty) return;

    // filling background with a linear gradient brush
    Brush backBrush = e.Cache.GetGradientBrush(e.Bounds, Color.LightSkyBlue,
      Color.Cornsilk, LinearGradientMode.Vertical);
    e.Cache.FillRectangle(backBrush, e.Bounds);
    // painting borders
    e.Cache.DrawRectangle(e.Cache.GetPen(Color.LightGray), e.Bounds);
    // painting row footer cell value
    Rectangle textBounds = Rectangle.Inflate(e.Bounds, -4, 0);
    e.Cache.DrawString(e.Text, e.Appearance.Font, e.Cache.GetSolidBrush(Color.Black),
      textBounds, e.Appearance.GetStringFormat());

    // prohibiting default painting
    e.Handled = true;
}
See Also