PivotGridControl.CustomDrawCell Event
Enables data cells to be painted manually.
Namespace: DevExpress.XtraPivotGrid
Assembly: DevExpress.XtraPivotGrid.v24.2.dll
NuGet Package: DevExpress.Win.PivotGrid
#Declaration
public event PivotCustomDrawCellEventHandler CustomDrawCell
#Event Data
The CustomDrawCell event's data class is PivotCustomDrawCellEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
Appearance | Gets the painted cell’s appearance settings. |
Bounds |
Gets the cell’s bounds.
Inherited from Pivot |
Column |
Gets the column custom total which displays the current cell.
Inherited from Pivot |
Column |
Gets the innermost column field which corresponds to the processed cell.
Inherited from Pivot |
Column |
For internal use.
Inherited from Pivot |
Column |
Gets the visual index of the column that contains the processed cell.
Inherited from Pivot |
Column |
Gets the type of column which contains the processed cell.
Inherited from Pivot |
Data |
Gets the data field which identifies the column where the processed cell resides.
Inherited from Pivot |
Display |
Gets the display text of the cell currently being processed.
Inherited from Pivot |
Focused |
Gets whether the processed cell is the focused cell.
Inherited from Pivot |
Graphics | Gets the object used to paint a cell. |
Graphics |
Gets an object which specifies the storage for the most used pens, fonts and brushes. |
Handled | Gets or sets whether an event was handled, if it was handled the default actions are not required. |
Row |
Gets the row custom total which contains the current cell.
Inherited from Pivot |
Row |
Gets the innermost row field that corresponds to the processed cell.
Inherited from Pivot |
Row |
For internal use.
Inherited from Pivot |
Row |
Gets the index of the row that contains the processed cell.
Inherited from Pivot |
Row |
Gets the type of row that contains the processed cell.
Inherited from Pivot |
Selected |
Gets whether the processed cell is selected.
Inherited from Pivot |
Summary |
Gets the summary type of the currently processed value.
Inherited from Pivot |
Summary |
Gets the summary value currently being processed.
Inherited from Pivot |
Thread |
Gets an event parameter that provides thread-safe access to event data. |
Value |
Gets the processed cell’s value.
Inherited from Pivot |
The event data class exposes the following methods:
Method | Description |
---|---|
Create |
Returns data records used to calculate a summary value for the cell.
Inherited from Pivot |
Create |
Returns data records used to calculate a summary value for the current cell. Allows you to specify the columns to return.
Inherited from Pivot |
Create |
Returns data records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to return.
Inherited from Pivot |
Create |
Returns data records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to return.
Inherited from Pivot |
Create |
Returns a list of records used to calculate a summary value for the specified cell asynchronously.
Inherited from Pivot |
Create |
Returns data records used to calculate a summary value for the current cell asynchronously. Allows you to specify the columns to return.
Inherited from Pivot |
Create |
Returns data records used to calculate a summary value for the current cell asynchronously. Allows you to specify the columns and limit the number of records to return.
Inherited from Pivot |
Create |
Returns data records used to calculate a summary value for the current cell asynchronously. Allows you to specify the columns and limit the number of records to return.
Inherited from Pivot |
Create |
Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns to be returned.
Inherited from Pivot |
Create |
Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to be returned.
Inherited from Pivot |
Create |
Obsolete. In server mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns to be returned.
Inherited from Pivot |
Create |
Obsolete. In server mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to be returned.
Inherited from Pivot |
Create |
Returns a summary data source.
Inherited from Pivot |
Default |
Performs default painting of an element. |
Get |
Returns a cell value calculated against the specified data field.
Inherited from Pivot |
Get |
Returns a cell value calculated for the current column and row field values, against the specified data field.
Inherited from Pivot |
Get |
Returns a cell value by the column and row indexes.
Inherited from Pivot |
Get |
Returns a cell value calculated for the specified column and row field values, against the specified data field.
Inherited from Pivot |
Get |
Returns a cell value calculated for the specified column and row field values, against the specified data field.
Inherited from Pivot |
Get |
Returns an array of column fields that correspond to the current cell.
Inherited from Pivot |
Get |
Returns a Column Grand Total value calculated for the current row field values, against the specified data field.
Inherited from Pivot |
Get |
Returns a Column Grand Total value calculated for the current row field values, against the specified data field.
Inherited from Pivot |
Get |
Returns a Column Grand Total value calculated for the specified row field values, against the specified data field.
Inherited from Pivot |
Get |
Returns a Column Grand Total value calculated for the specified row field values, against the specified data field.
Inherited from Pivot |
Get |
Returns the specified column or row field’s value for the cell, addressed by its zero-based index in the data area.
Inherited from Pivot |
Get |
Returns the value of the specified column or row field that identifies the column/row in which the processed cell resides.
Inherited from Pivot |
Get |
Returns a field value that belongs to the specified field and corresponds to a data cell with the specified column or row index.
Inherited from Pivot |
Get |
Returns a field value that belongs to the specified field and corresponds to the current data cell.
Inherited from Pivot |
Get |
Gets the Grand Total value for the specified field.
Inherited from Pivot |
Get |
Returns the Grand Total value calculated against the specified data field.
Inherited from Pivot |
Get |
Returns the value of the cell in the same row but in the next column.
Inherited from Pivot |
Get |
Returns the value of the cell located in the next column of the current row.
Inherited from Pivot |
Get |
Returns the value of the cell in the next row.
Inherited from Pivot |
Get |
Returns the value of the cell located in the next row of the current column.
Inherited from Pivot |
Get |
Returns the value of the cell in the same row but in the previous column.
Inherited from Pivot |
Get |
Returns the value of the cell located in the previous column of the current row.
Inherited from Pivot |
Get |
Returns the value of the cell in the previous row.
Inherited from Pivot |
Get |
Returns the value of the cell located in the previous row of the current column.
Inherited from Pivot |
Get |
Returns an array of the row fields that correspond to the current cell.
Inherited from Pivot |
Get |
Returns a Row Grand Total value calculated for the current column field values, against the specified data field.
Inherited from Pivot |
Get |
Returns a Row Grand Total value calculated for the current column field values, against the specified data field.
Inherited from Pivot |
Get |
Returns a Row Grand Total value calculated for the specified column field values, against the specified data field.
Inherited from Pivot |
Get |
Returns a Row Grand Total value calculated for the specified column field values, against the specified data field.
Inherited from Pivot |
Is |
Indicates whether the specified field’s value that represents the row or column header of the processed cell is expanded.
Inherited from Pivot |
Is |
Indicates whether a field value that belongs to the specified field and corresponds to the current cell is expanded.
Inherited from Pivot |
Is |
Gets whether the value of the specified column or row field can be retrieved for the current cell by the Pivot |
Is |
Gets whether the value of the specified column or row field can be retrieved for the current cell by the Pivot |
Is |
Indicates whether the processed data cell resides within the “Others” row/column when the Top X Value feature is enabled.
Inherited from Pivot |
Is |
Indicates whether the current data cell resides within the “Others” row/column when the Top X Value feature is enabled.
Inherited from Pivot |
#Remarks
The CustomDrawCell event is raised before a data cell is painted. The event parameter provides all the information necessary to paint a cell. Set the PivotCustomDrawCellEventArgs.Handled property to true to prohibit default cell painting.
Note
Custom drawing of any kind is ignored when printing Pivot
Note
To access event data while an asynchronous operation is being performed, use a thread-safe event parameter returned by the Pivot
Important
Do not change cell values, modify the control’s layout, or change the control’s object model in the events used for custom control painting. Actions that update the layout can cause the control to malfunction.
#Example
The following sample code handles the PivotGridControl.CustomDrawCell
event to custom paint Grand Total cells. The image below shows the result.
using DevExpress.XtraPivotGrid;
using System.Drawing;
private void PivotGridControl1_CustomDrawCell(object sender, PivotCustomDrawCellEventArgs e)
{
if (e.ColumnValueType == PivotGridValueType.GrandTotal ||
e.RowValueType == PivotGridValueType.GrandTotal)
{
Rectangle r;
Brush brushFillTotals;
brushFillTotals = e.GraphicsCache.GetSolidBrush(ColorTranslator.FromHtml("#0099cc"));
r = e.Bounds;
e.GraphicsCache.FillRectangle(brushFillTotals, e.Bounds);
r.Inflate(-4, -4);
e.GraphicsCache.DrawString(e.DisplayText, e.Appearance.Font,
Brushes.White, r, e.Appearance.GetStringFormat());
e.Handled = true;
}
}