GridView.CustomDrawFooterCell Event

Enables you to paint view footer cells manually.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v18.1.dll

Declaration

C#

[DXCategory("CustomDraw")]
public event FooterCellCustomDrawEventHandler CustomDrawFooterCell

VB.NET

<DXCategory("CustomDraw")>
Public Event CustomDrawFooterCell As FooterCellCustomDrawEventHandler

Event Data

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

Property	Description
Appearance	Gets the painted element’s appearance settings. Inherited from CustomDrawEventArgs.
Bounds	Returns a value specifying limits for the drawing area. Inherited from CustomDrawEventArgs.
Cache	Provides methods to paint on drawing surfaces in GDI+ and DirectX modes. See DirectX hardware acceleration to learn more. Inherited from CustomDrawEventArgs.
Column	Gets the column containing the painted element. Inherited from RowCellObjectCustomDrawEventArgs.
Graphics	A GDI+ drawing surface. Use the CustomDrawEventArgs.Cache property instead if you enable the DirectX hardware acceleration. 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.
Info	Gets an object providing information necessary to paint a footer cell.
Painter	Gets the painter object that provides the default element painting mechanism. Inherited from CustomDrawObjectEventArgs.
RowHandle	Gets the handle of the row whose corresponding element is being painted. Inherited from RowObjectCustomDrawEventArgs.

The event data class exposes the following methods:

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

Remarks

The CustomDrawFooterCell event fires each time a view footer cell needs to be repainted. The footer cell’s column is identified by the RowCellObjectCustomDrawEventArgs.Column parameter. See the Custom Painting Basics and Custom Painting Scenarios topics for information on using custom draw events.

Note

You can change the background color of footer cells via the CustomDrawEventArgs.Appearance parameter in the following paint styles: Flat, WindowsXP, Style3D, UltraFlat, MixedXP and Web. Use the BaseView.PaintStyleName property to change the paint style.

Note

The control’s events designed to change the appearance or rendering of control elements must not be used to update cell values or to modify the control’s layout. Any inappropriate operation which causes a layout update, may break the normal control behavior.

Online Video

WinForms Grid - How to Custom Draw Footer Cells.

Example

The example shows how you can perform custom painting of footer cells with the GridView.CustomDrawFooterCell event.

C#

using DevExpress.XtraGrid.Views.Grid;
using DevExpress.Utils.Drawing;

private void gridView1_CustomDrawFooterCell(object sender, FooterCellCustomDrawEventArgs e) {
    int dx = e.Bounds.Height;
    Brush brush = e.Cache.GetGradientBrush(e.Bounds, Color.Wheat, Color.FloralWhite,
      LinearGradientMode.Vertical);
    Rectangle r = e.Bounds;
    //Draw a 3D border
    BorderPainter painter = BorderHelper.GetPainter(DevExpress.XtraEditors.Controls.BorderStyles.Style3D);
    AppearanceObject borderAppearance = new AppearanceObject(e.Appearance);
    borderAppearance.BorderColor = Color.DarkGray;
    painter.DrawObject(new BorderObjectInfoArgs(e.Cache, borderAppearance, r));
    //Fill the inner region of the cell
    r.Inflate(-1, -1);
    e.Cache.FillRectangle(brush, r);
    //Draw a summary value
    r.Inflate(-2, 0);
    e.Appearance.DrawString(e.Cache, e.Info.DisplayText, r);
    //Prevent default drawing of the cell
    e.Handled = true;
}

VB.NET

Imports System.Drawing.Drawing2D
Imports DevExpress.XtraGrid.Views.Grid

Private Sub GridView1_CustomDrawFooterCell(ByVal sender As Object, _
ByVal e As FooterCellCustomDrawEventArgs) Handles GridView1.CustomDrawFooterCell
    Dim dx As Integer = e.Bounds.Height
    Dim brush As Brush = e.Cache.GetGradientBrush(e.Bounds, Color.Wheat, Color.FloralWhite, LinearGradientMode.Vertical)
    Dim r As Rectangle = e.Bounds
    'Draw a 3D border
    BorderPainter painter = BorderHelper.GetPainter(DevExpress.XtraEditors.Controls.BorderStyles.Style3D)
    Dim borderAppearance As AppearanceObject = New AppearanceObject(e.Appearance)
    borderAppearance.BorderColor = Color.DarkGray
    painter.DrawObject(new BorderObjectInfoArgs(e.Cache, borderAppearance, r))
    'Fill the inner region of the cell
    r.Inflate(-1, -1)
    e.Cache.FillRectangle(brush, r)
    'Draw a summary value
    r.Inflate(-2, 0)
    e.Appearance.DrawString(e.Cache, e.Info.DisplayText, r)
    'Prevent default drawing of the cell
    e.Handled = True
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CustomDrawFooterCell event.

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-display-multiply-summaries-in-the-same-column-e2217/CS/MyXtraGrid/MyGridView.cs#L29

{
    CustomDrawFooterCell += MyGridView_CustomDrawFooterCell;
    CustomDrawRowFooterCell += MyGridView_CustomDrawRowFooterCell;

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

this.gridView1.OptionsView.ShowFooter = true;
this.gridView1.CustomDrawFooterCell += new DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventHandler(this.gridView1_CustomDrawFooterCell);
//

VB.NET

how-to-display-multiply-summaries-in-the-same-column-e2217/VB/MyXtraGrid/MyGridView.vb#L38

MyBase.New(grid)
AddHandler CustomDrawFooterCell, AddressOf MyGridView_CustomDrawFooterCell
AddHandler CustomDrawRowFooterCell, AddressOf MyGridView_CustomDrawRowFooterCell

how-to-calculate-summary-using-summary-values-calculated-by-other-columns-e2488/VB/Q273845/Form1.vb#L35

Private Sub gridView1_CustomDrawFooterCell(ByVal sender As Object, ByVal e As FooterCellCustomDrawEventArgs) Handles gridView1.CustomDrawFooterCell
    If e.Column Is colPrice Then e.Info.DisplayText = (Convert.ToDecimal(colUnitPrice.SummaryItem.SummaryValue) * Convert.ToDecimal(colUnitsInStock.SummaryItem.SummaryValue)).ToString()

how-to-conditionally-change-the-text-color-of-a-footer-summary-cell-e1641/VB/WindowsApplication2/Form1.vb#L24

Private Sub gridView1_CustomDrawFooterCell(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventArgs) Handles gridView1.CustomDrawFooterCell
    If e.Column.FieldName = "Amount" Then

how-to-customize-the-gridcontrols-print-output-e2667/VB/MyXtraGrid/Form1.vb#L32

Private Sub myGridView1_CustomDrawFooterCell(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventArgs) Handles myGridView1.CustomDrawFooterCell
    Dim isPrinting As Boolean = e.Handled

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

Private Sub gridView1_CustomDrawFooterCell(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.FooterCellCustomDrawEventArgs) Handles gridView1.CustomDrawFooterCell
    Dim view As GridView = TryCast(sender, GridView)