xtrareports-devexpress-dot-xtrareports-dot-ui-dot-xrpivotgrid-72344c79.md
Enables you to specify a custom column width or hide certain columns based on specified criteria.
Namespace : DevExpress.XtraReports.UI
Assembly : DevExpress.XtraReports.v25.2.dll
NuGet Package : DevExpress.Reporting.Core
public event EventHandler<PivotCustomColumnWidthEventArgs> CustomColumnWidth
Public Event CustomColumnWidth As EventHandler(Of PivotCustomColumnWidthEventArgs)
The CustomColumnWidth event's data class is PivotCustomColumnWidthEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| ColumnIndex | Gets the visual index of the column that contains the processed cell. |
| ColumnWidth | Specifies the width of the current column. |
| CustomTotal | Gets the custom total that corresponds to the currently processed column/row header. 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 the number of rows in the pivot grid. |
| 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>. |
| GetColumnCellValue(Int32) | Returns a cell value calculated for the specified row field value, against the specified data field. |
| 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>. |
The following code snippet sets the width of the “2” quarter column in the exported document:
using DevExpress.XtraPivotGrid;
using DevExpress.XtraReports.UI;
using DevExpress.XtraReports.UI.PivotGrid;
// ...
void PivotCustomColumnWidth(object sender, PivotCustomColumnWidthEventArgs e) {
if(object.Equals(e.Value, 2) && e.ValueType != PivotGridValueType.Total)
e.ColumnWidth = 120;
}
Imports DevExpress.XtraPivotGrid
Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraReports.UI.PivotGrid
' ...
Private Sub PivotCustomColumnWidth(ByVal sender As Object, ByVal e As PivotCustomColumnWidthEventArgs)
If Object.Equals(e.Value, 2) AndAlso e.ValueType <> PivotGridValueType.Total Then
e.ColumnWidth = 120
End If
End Sub
View Example: Dashboard for WinForms - How to Export the Customized Pivot Grid Item
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomColumnWidth 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.
winforms-dashboard-pivot-custom-export/CS/WinformsExport/Form1.cs#L34
if(pivot2 != null) {
pivot2.CustomColumnWidth += PivotCustomColumnWidth;
pivot2.CustomRowHeight += PivotCustomRowHeight;
winforms-dashboard-pivot-custom-export/VB/WinFormsExport/Form1.vb#L36
If pivot2 IsNot Nothing Then
AddHandler pivot2.CustomColumnWidth, AddressOf PivotCustomColumnWidth
AddHandler pivot2.CustomRowHeight, AddressOf PivotCustomRowHeight
See Also