Skip to main content
All docs
V25.1

DxPivotTableField Members

Defines a field that supplies data for the Pivot Table component.

Constructors

Name Description
DxPivotTableField() Initializes a new instance of the DxPivotTableField class.

Properties

Name Description
AllowDrag Specifies whether users can drag the field header and drop it onto another area.
AllowedAreas Specifies areas where the field can be displayed.
Area Specifies the area where the field is displayed.
AreaIndex Specifies the field’s index among other fields displayed within the same area.
Caption Specifies the field’s caption displayed in Pivot Table’s header.
CellFormat Specifies the display format for data cells.
CellTemplate Specifies a template for data cells that correspond to the current field.
Field Specifies the name of the database field that is assigned to the current object.
FilterFieldName Returns the filter field name that is used by the filtering mechanism.
FilterMenuButtonDisplayMode Specifies when the field header displays a filter menu button.
FilterMenuTemplate Specifies a template used to display the field’s Filter Menu in the Pivot Table.
GroupInterval Gets or sets how the Pivot Table groups values of the current column or row field. Mostly used for DateTime values.
HeaderTemplate Specifies a template to display the current field’s caption.
Name Specifies the field’s unique name.
ShowInHiddenFieldList Specify whether to display the field in Hidden Fields section of the Field List.
SortOrder Specifies the field’s sort order (ascending or descending).
SummaryType Specifies the type of the summary function which is calculated against the current data field values.
ValueFormat Specifies the display format for field values displayed in rows or columns.
ValueTemplate Specifies a template to display the current field’s values.
Visible Specifies whether the Pivot Table field is visible.
Width Specifies the width of cells where the field values are displayed.

Methods

Name Description
ChangeSortOrder() Changes the field’s sort order.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
ToString() Returns a string that represents the current object. Inherited from Object.

Events

Name Description
AreaChanged Fires when users drag the field to another area and the field’s Area property value changes.
AreaIndexChanged Fires when users reorder fields within an area and the field’s AreaIndex property value changes.
See Also