TcxPivotGridCustomization Class
Stores Customization Form settings.
Declaration
TcxPivotGridCustomization = class(
TcxPivotGridCustomOptions
)Remarks
The customization form allows end-users to add and remove fields and field groups from the pivot grid at runtime using drag-and-drop operations.
The customization form can be invoked or hidden via:
the pivot grid’s Customization.Visible property;
Grouped fields are represented in the customization form by a corresponding group header which displays the group’s Caption and the expand button. Empty groups (groups which don’t contain any fields) are not displayed within the customization form.
Dragging a field by its header and dropping it within the customization form’s client area hides the field from the pivot grid. The field reappears when its header is dragged from the customization form to the pivot grid’s client area. Note that when a field’s Hidden property is set to True, its header is not displayed in the customization form. The only way to show such a field in the control is to set its Visible property to True.
You can add fields to the specified area without using drag and drop. To do this, select the desired field header within the customization form, and choose the area in which the field should be placed from the dropdown list and then click the Add To button or simply double-click the field header within the customization form.
To quickly hide a field, end-users can:
select the ‘Hide’ item in the field header context menu, provided that this built-in menu is enabled via the pivot grid’s PopupMenus.FieldHeaderMenu.UseBuiltInMenu property;
drop the field outside the header area, provided that the customization form is displayed and the pivot grid’s OptionsCustomize.Hiding property is set to True.
Note that the customization form is recreated each time it is displayed. When the form is being displayed or hidden, the pivot grid’s OnCustomization event is raised.
To specify the form’s location and size, use the Customization.FormBounds and Customization.Site properties.
Customization form appearance
You can control how the customization form will look by using the customization form’s FormStyle setting. In an advanced style (the FormStyle is cfsAdvanced), the customization form displays additional panes mirroring related drop areas. This is handy in situations when fields in the View are clipped or drop areas are hidden. Manipulating fields across panes allows end-users to modify the report from within the customization form, without changing the View layout.
OLAP mode
In OLAP mode, the Customization Form groups cube elements within corresponding categories and folders based on the cube definition.
| Member | Description |
|---|---|
| Customization.AvailableFieldsSorted | Specifies the field list sorting mode. |
| Customization.Form | Provides access to the Customization Form. |
| Customization.FormBounds | Specifies the Customization Form’s bounding rectangle. |
| Customization.FormStyle | Specifies the Customization Form mode. |
| Customization.Site | Specifies the Customization Form site. |
| Customization.Visible | Specifies the Customization Form visibility. |
Direct TcxPivotGridCustomization Class Reference
The TdxCustomPivotGrid.Customization property references a TcxPivotGridCustomization object.