PivotGridXlsxExportOptions.CustomizeCell Event

Allows you to customize a PivotGrid’s cell in the exported XLSX document. Only available in data-aware export mode.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v24.1.dll

NuGet Package: DevExpress.Wpf.PivotGrid

Declaration

C#

public event CustomizePivotCellEventHandler CustomizeCell

VB.NET

Public Event CustomizeCell As CustomizePivotCellEventHandler

Remarks

Follow the steps below to customize data in the output document.

1. Create the PivotGridXlsxExportOptions instance.
2. Handle the PivotGridXlsxExportOptions.CustomizeCell event.
3. Use the CustomizePivotCellEventArgs.Formatting property to specify the cell’s appearance settings.
4. Use the CustomizePivotCellEventArgs.ValueItemInfo property to specify the field to which the customized cell belongs.
5. To export cells with custom formatting, set the Handled parameter to true.
6. To export customized data from a PivotGrid Control, pass the PivotGridXlsxExportOptions instance to the ExportToXlsx method.

The following example exports data from a PivotGrid Control to Xlsx format. The PivotGridXlsxExportOptions.CustomizeCell event is used to change the background color of the “Category Name” column in the output document.

C#

//...
void op_CustomizeCell(CustomizePivotCellEventArgs e){
       if (e.ValueItemInfo != null && e.ValueItemInfo.Field == fieldCategoryName) 
      {
          e.Formatting.BackColor = Color.AliceBlue;
          e.Handled = true;
      }

  }
void Button_Click(object sender, RoutedEventArgs e) {
    PivotGridXlsxExportOptions op = new PivotGridXlsxExportOptions();
    op.CustomizeCell += op_CustomizeCell;
    pivorGrid1.ExportToXlsx(file, op);
}

VB.NET

'...
Private Sub op_CustomizeCell(ByVal e As CustomizePivotCellEventArgs)
      If e.ValueItemInfo IsNot Nothing AndAlso e.ValueItemInfo.Field = fieldCategoryName Then
          e.Formatting.BackColor = Color.AliceBlue
          e.Handled = True
      End If

End Sub
Private Sub Button_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Dim op As New PivotGridXlsxExportOptions()
    AddHandler op.CustomizeCell, AddressOf op_CustomizeCell
    pivorGrid1.ExportToXlsx(file, op)
End Sub