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

PivotGridControl.CustomColumnWidth Event

Enables the column width to be customized.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v19.1.dll

Declaration

public event EventHandler<PivotCustomColumnWidthEventArgs> CustomColumnWidth
Public Event CustomColumnWidth As EventHandler(Of PivotCustomColumnWidthEventArgs)

Event Data

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

Property Description
ColumnCount Gets the number of PivotGridControl columns in the data area.
ColumnIndex Gets the column zero-based index for fields located in the data area.
ColumnLineCount Gets the height of the column field values located in the column header area, in text lines.
ColumnWidth Gets or sets a width for the data area columns.
CustomTotal Gets the custom total that corresponds to the currently processed column/row header. Inherited from PivotFieldValueEventArgsBase<T>.
Data For internal use. Inherited from PivotFieldValueEventArgsBase<T>.
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 a number of PivotGridControl rows 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) 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>.
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>.
GetColumnCellValue(Int32) Returns the specified column field value for the cell addressed by its zero-based index in the data area.
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>.

Remarks

The CustomColumnWidth event allows you to customize the column width of the Pivot Grid control. To do this, use the PivotCustomColumnWidthEventArgs.ColumnWidth property. To get the index of a specified column cell, use the PivotCustomColumnWidthEventArgs.ColumnIndex property. Use the PivotCustomColumnWidthEventArgs.RowCount property to get the number of Pivot Grid Control rows in the column.

To specify the row height, use the PivotGridControl.CustomRowHeight event.

See Also