PivotGridControl.CustomRowHeight Event
Enables the rows height to be customized.
Namespace: DevExpress.XtraPivotGrid
Assembly: DevExpress.XtraPivotGrid.v23.2.dll
NuGet Package: DevExpress.Win.PivotGrid
Declaration
Event Data
The CustomRowHeight event's data class is PivotCustomRowHeightEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| ColumnCount | Gets a number of PivotGridControl columns in the data area. |
| CustomTotal | Gets the custom total that corresponds to the currently processed column/row header. Inherited from PivotFieldValueEventArgsBase<T>. |
| Data | This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from PivotFieldValueEventArgs. |
| DataField | Gets the data field that specifies the processed value. Inherited from PivotFieldValueEventArgsBase<T>. |
| Field | Gets the field being processed. Inherited from PivotFieldEventArgsBase<T>. |
| FieldIndex | Gets the field position among the visible fields within the header area. Inherited from PivotFieldValueEventArgsBase<T>. |
| IsCollapsed | Gets whether the processed field value is collapsed. Inherited from PivotFieldValueEventArgsBase<T>. |
| IsColumn | Gets whether the field is displayed within the Column Header Area. Inherited from PivotFieldValueEventArgsBase<T>. |
| IsOthersValue | Gets or sets whether the current header corresponds to the “Others” row/column. Inherited from PivotFieldValueEventArgsBase<T>. |
| Item | For internal use. Inherited from PivotFieldValueEventArgsBase<T>. |
| MaxIndex | Gets the maximum row index (for row fields) or column index (for column fields) that corresponds to the processed field value. Inherited from PivotFieldValueEventArgsBase<T>. |
| MinIndex | Gets the minimum row index (for row fields) or column index (for column fields) that corresponds to the processed field value. Inherited from PivotFieldValueEventArgsBase<T>. |
| RowCount | Gets the number of PivotGridControl rows in the data area. |
| RowHeight | Gets or sets a height for the data area rows. |
| RowIndex | Gets the row zero-based index for fields located in the data area. |
| Value | Gets the column field or row field value that corresponds to the currently processed column/row header. Inherited from PivotFieldValueEventArgsBase<T>. |
| ValueType | Gets the type of the currently processed header of a column or a row. Inherited from PivotFieldValueEventArgsBase<T>. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| ChangeExpandedState() | Changes the expanded state of the field value currently being processed. Inherited from PivotFieldValueEventArgsBase<T>. |
| CreateDrillDownDataSource() | Returns data records that are used to calculate a summary value for the specified cell. Inherited from PivotFieldValueEventArgsBase<T>. |
| CreateDrillDownDataSource(List<String>) | Returns data records that are used to calculate a summary value for the specified cell. Inherited from PivotFieldValueEventArgsBase<T>. |
| CreateDrillDownDataSource(Int32, List<String>) | Returns data records used to calculate a summary value for the specified cell in OLAP and server mode. Inherited from PivotFieldValueEventArgsBase<T>. |
| CreateDrillDownDataSource(Int32) | Returns data records that are used to calculate a summary value for the specified cell. Inherited from PivotFieldValueEventArgsBase<T>. |
| CreateOLAPDrillDownDataSource(Int32, List<String>) | Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the specified cell. Inherited from PivotFieldValueEventArgsBase<T>. |
| CreateServerModeDrillDownDataSource(Int32, List<String>) | Obsolete. In server mode, returns a list of records used to calculate a summary value for the specified cell. Inherited from PivotFieldValueEventArgsBase<T>. |
| GetCellValue(Int32, Int32) | Returns a value displayed in the specified cell. Inherited from PivotFieldValueEventArgsBase<T>. |
| GetFieldValue(T, Int32) | Returns the specified column or row field value for the cell, addressed by its zero-based index in the Data Area. Inherited from PivotFieldValueEventArgsBase<T>. |
| GetHigherLevelFields() | Returns the parent field for the field value currently being processed. Inherited from PivotFieldValueEventArgsBase<T>. |
| GetHigherLevelFieldValue(T) | Returns the value of a specific parent field corresponding to the field value currently being processed. Inherited from PivotFieldValueEventArgsBase<T>. |
| GetRowCellValue(Int32) | Returns the specified row field value for the cell addressed by its zero-based index in the data area. |
Remarks
The CustomRowHeight event allows you to customize the row height of a Pivot Grid control. To do this, use the PivotCustomRowHeightEventArgs.RowHeight property. To get the index of specified row cell, use the PivotCustomRowHeightEventArgs.RowIndex property. Use the PivotCustomRowHeightEventArgs.ColumnCount property to get the number of Pivot Grid Control’s columns in the row.
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.
To specify the column width, use the PivotGridControl.CustomColumnWidth event.