Skip to main content
BuyLog In
VCL
Search in…
Docs > VCL Controls > ExpressPivotGrid Suite > API Reference > cxCustomPivotGrid > TcxPivotGridField > Members
All docs
V25.1
    • VCL Controls
    What's New
    Installation
    Express Cross Platform Library
    ExpressQuantumGrid Suite
    ExpressEditors Library
    ExpressBars Suite
    ExpressCharts Suite
    ExpressReports Suite
    ExpressRichEditControl Suite
    ExpressSkins Library
    ExpressScheduler Suite
    ExpressSpreadSheet Suite
    ExpressQuantumTreeList Suite
    ExpressPDFViewer Suite
    ExpressPrinting System
    ExpressLayoutControl Suite
    ExpressNavBar Suite
    ExpressPivotGrid Suite
    Print and Export
    Concepts
    Visual Elements
    Design-Time Features
    End-User Capabilities
    API Reference
    cxCustomPivotGrid
    IcxPivotGridBaseStyles
    IcxPivotGridDesignerIntf
    IcxPivotGridField
    IcxPivotGridListener
    IcxPivotGridSizableObject
    TcxCustomPivotGrid
    TcxOLAPKPIType
    TcxPivotGridCalculateCustomSummaryEvent
    TcxPivotGridCalculationBaseType
    TcxPivotGridColumnTotalsLocation
    TcxPivotGridCompareEvent
    TcxPivotGridCrossCell
    TcxPivotGridCrossCellDataSource
    TcxPivotGridCrossCellSummary
    TcxPivotGridCustomCellViewInfo
    TcxPivotGridCustomCustomizationForm
    TcxPivotGridCustomDrawCellEvent
    TcxPivotGridCustomDrawEvent
    TcxPivotGridCustomDrawFieldHeaderEvent
    TcxPivotGridCustomDrawGroupHeaderEvent
    TcxPivotGridCustomDrawPartEvent
    TcxPivotGridCustomOLAPDataSource
    TcxPivotGridCustomOptions
    TcxPivotGridCustomPopupMenu
    TcxPivotGridCustomStyles
    TcxPivotGridCustomTotal
    TcxPivotGridCustomTotalCollection
    TcxPivotGridCustomization
    TcxPivotGridCustomizationFormFieldListType
    TcxPivotGridCustomizationFormStyle
    TcxPivotGridDataCellLimitValueType
    TcxPivotGridDataCellLimitValueTypes
    TcxPivotGridDataCellViewInfo
    TcxPivotGridDataFieldArea
    TcxPivotGridDragDropAreaInfo
    TcxPivotGridEditContainerViewInfo
    TcxPivotGridField
    Members
    Constructors
    Properties
    Methods
    Events
    TcxPivotGridFieldArea
    TcxPivotGridFieldAreas
    TcxPivotGridFieldChangedEvent
    TcxPivotGridFieldDataBinding
    TcxPivotGridFieldDataVisibility
    TcxPivotGridFieldFilter
    TcxPivotGridFieldGetGroupImageIndex
    TcxPivotGridFieldGroup
    TcxPivotGridFieldGroupCollection
    TcxPivotGridFieldHeaderCellViewInfo
    TcxPivotGridFieldHeaderMenu
    TcxPivotGridFieldHeaderPopupMenuItem
    TcxPivotGridFieldHeaderPopupMenuItems
    TcxPivotGridFieldOptions
    TcxPivotGridFieldStyles
    TcxPivotGridFields
    TcxPivotGridFilterButtonShowMode
    TcxPivotGridFilterType
    TcxPivotGridFocusRectStyle
    TcxPivotGridGetCellHintEvent
    TcxPivotGridGetContentStyleEvent
    TcxPivotGridGetDisplayTextEvent
    TcxPivotGridGetFieldHeaderStyleEvent
    TcxPivotGridGetGroupValueDisplayTextEvent
    TcxPivotGridGetGroupValueEvent
    TcxPivotGridGetHeaderItemStyleEvent
    TcxPivotGridGetPropertiesEvent
    TcxPivotGridGetTotalDisplayTextEvent
    TcxPivotGridGroupInterval
    TcxPivotGridGroupItem
    TcxPivotGridGroupItemClass
    TcxPivotGridGroupValueMenu
    TcxPivotGridGroupValuePopupMenuItem
    TcxPivotGridGroupValuePopupMenuItems
    TcxPivotGridHeaderAreaMenu
    TcxPivotGridHeaderCellViewInfo
    TcxPivotGridHitTest
    TcxPivotGridInitializeFieldEvent
    TcxPivotGridLines
    TcxPivotGridOLAPField
    TcxPivotGridOLAPFieldOptions
    TcxPivotGridOLAPFieldSortMode
    TcxPivotGridOLAPFieldType
    TcxPivotGridOLAPKPIGraphicType
    TcxPivotGridOptionsBehavior
    TcxPivotGridOptionsCustomize
    TcxPivotGridOptionsData
    TcxPivotGridOptionsDataField
    TcxPivotGridOptionsLockedStateImage
    TcxPivotGridOptionsPrefilter
    TcxPivotGridOptionsSelection
    TcxPivotGridOptionsSelectionInclude
    TcxPivotGridOptionsSelectionIncludes
    TcxPivotGridOptionsView
    TcxPivotGridPopupMenuClickEvent
    TcxPivotGridPopupMenuPopupEvent
    TcxPivotGridPopupMenus
    TcxPivotGridPrefilterPosition
    TcxPivotGridPrefilterVisible
    TcxPivotGridPrepareLockedStateImageEvent
    TcxPivotGridRecords
    TcxPivotGridRowTotalsLocation
    TcxPivotGridShowHeaderFilterButtons
    TcxPivotGridSortBySummaryInfo
    TcxPivotGridStyleSheet
    TcxPivotGridStyles
    TcxPivotGridSummaryType
    TcxPivotGridSummaryTypes
    TcxPivotGridSummaryVariation
    TcxPivotGridTotalsLocation
    TcxPivotGridTotalsVisibility
    TcxPivotGridVariantList
    TcxPivotGridViewData
    TcxPivotGridViewDataItem
    TcxPivotGridViewDataSelection
    TcxPivotList
    cxPivotGridDefaultFieldFloatFormat
    cxPivotGridDefaultFieldIntFormat
    cxPivotGridDefaultFieldMinWidth
    cxPivotGridDefaultFieldPercentFormat
    cxPivotGridDefaultFieldWidth
    cxPivotGridDefaultGroupIntervalRange
    cxPivotGridDropArrowColor
    cxPivotGridDropDownMaxItemCount
    cxPivotGridDropDownWidth
    cxPivotGridFilterPopupMinWidth
    cxPivotGridInvalidIndex
    cxPivotPatternChar
    gs_Background
    gs_ColumnHeader
    gs_ColumnHeaderArea
    gs_ColumnMaximumValue
    gs_ColumnMinimumValue
    gs_Content
    gs_DataHeaderArea
    gs_FieldHeader
    gs_FilterHeaderArea
    gs_FilterSeparator
    gs_HeaderBackground
    gs_Inactive
    gs_MaximumValue
    gs_MinimumValue
    gs_Prefilter
    gs_RowHeader
    gs_RowHeaderArea
    gs_RowMaximumValue
    gs_RowMinimumValue
    gs_Selected
    gs_Total
    htcButton
    htcCustomizationForm
    htcDataCell
    htcDataHeader
    htcFieldHeader
    htcFieldList
    htcFieldTreeView
    htcFilter
    htcGroupHeader
    htcHeaderArea
    htcHorzSizingEdge
    htcPrefilter
    htcPrefilterActivateButton
    htcPrefilterCaption
    htcPrefilterCloseButton
    htcPrefilterCustomizationButton
    htcPrefilterDropDownButton
    pgcmCollapse
    pgcmCollapseAll
    pgcmExpand
    pgcmExpandAll
    pgcmHide
    pgcmHideCustomization
    pgcmMoveToBeginning
    pgcmMoveToEnd
    pgcmMoveToLeft
    pgcmMoveToRight
    pgcmShowCustomization
    pgcmShowPrefilterDialog
    cxDBPivotGrid
    cxExportPivotGridLink
    cxPivotGrid
    cxPivotGridAdvancedCustomization
    cxPivotGridChartConnection
    cxPivotGridCustomDataSet
    cxPivotGridDrillDownDataSet
    cxPivotGridOLAPADOMDProvider
    cxPivotGridOLAPConnectionDesigner
    cxPivotGridOLAPDataSource
    cxPivotGridOLAPOLEDBProvider
    cxPivotGridSummaryDataSet
    ExpressVerticalGrid Suite
    ExpressDocking Library
    ExpressMemData
    ExpressDataController
    ExpressSpellChecker Suite
    ExpressMapControl Suite
    ExpressGanttControl Suite
    ExpressGaugeControl Suite
    ExpressTileControl Suite
    ExpressFlowChart Suite
    ExpressFlowChart Editor
    ExpressOrgChart Suite
    ExpressPageControl Suite
    ExpressWizardControl Suite

    TcxPivotGridField Members

    An unbound pivot grid.

    Constructors

    Name Description
    Create(TComponent) Inherited from TComponent.

    Properties

    Name Description
    ActualWidth Returns the on-screen field‘s width in pixels.
    AllowedAreas Specifies areas where the field can be positioned.
    Area Specifies the area in which the field is displayed.
    AreaIndex Specifies the position of the field amongst the other fields within the same area.
    Caption Specifies the field’s display caption.
    ComObject Inherited from TComponent.
    ComponentCount Inherited from TComponent.
    ComponentIndex Inherited from TComponent.
    Components Inherited from TComponent.
    ComponentState Inherited from TComponent.
    ComponentStyle Inherited from TComponent.
    CustomTotals Provides indexed access to custom totals that are calculated for the current field.
    DataBinding Specifies an object which links the current field to data storage.
    DataVisibility Specifies the cell visibility for data fields.
    DesignInfo Inherited from TComponent.
    DisplayFormat Specifies the formatting pattern used to display field values.
    FieldInCompactLayout
    Filter Provides access to the filter applied to the current field.
    Group Specifies the group in which the field is contained.
    GroupExpanded Specifies the expansion state of the field in a group.
    GroupIndex Specifies the index of the group in which the field is contained.
    GroupInterval Specifies how the values of the current column field or row field are combined into groups.
    GroupIntervalAdvanced
    GroupIntervalRange Specifies the length of the intervals when values are grouped together.
    GroupValueList Provides indexed access to the list of the field’s grouping values.
    Hidden Specifies whether the field is displayed within the customization form.
    ImageAlign Specifies the alignment of an image within the header of the current field.
    ImageIndex Specifies the index of an image associated with the field.
    Index Specifies the position of the current field within the control’s field collection.
    IsCaptionAssigned
    IsHierarchy Determines if the current field is associated with a cube hierarchy element (in OLAP mode).
    IsLastVisibleInArea
    MinWidth Specifies the minimum field‘s width in pixels.
    Name Inherited from TComponent.
    Observers Inherited from TComponent.
    Options Contains a set of options which control end-user abilities with regard to changing an item’s contents and the appearance of item cells.
    Owner Inherited from TComponent.
    PivotGrid Specifies the pivot grid control that owns the current field.
    Properties Provides access to active editor settings.
    PropertiesClass Specifies a reference to the editor properties class that corresponds to the active editor type.
    PropertiesClassName Specifies the active editor type by its class name.
    RecordCount Returns the total number of records that provide data for the field.
    RepositoryItem Specifies an edit repository item component for the pivot grid field.
    SortBySummaryInfo Specifies the options used to sort the values of the current column field and row field by grand total summary values.
    SortedBySummary Indicates whether the values of the current field are sorted by the grand total summary values of a data field.
    SortOrder Specifies the field‘s sort order.
    Styles Represents style settings for the current field’s visual elements.
    SummaryIndex Determines the position of the current field within the SummaryFields collection.
    SummaryType Specifies the type of the summary function which is calculated against the current field’s values.
    SummaryVariation Specifies how a summary value that is calculated against the current data field is represented in a data cell.
    Tag Inherited from TComponent.
    TopValueCount Specifies the total number of the field values that are to be displayed for the current column field or row field.
    TopValueShowOthers Specifies whether the ‘Others’ item is displayed in the pivot grid when the Top N Values feature is enabled.
    TotalsVisibility Specifies the type of the totals calculated and displayed within the pivot grid for the current field.
    UniqueName In OLAP mode, specifies the full name of a cube element that is bound to the current field.
    Values Provides access to the values of the current field.
    VCLComObject Inherited from TComponent.
    Visible Specifies whether the current field is displayed within the pivot grid.
    VisibleIndex
    VisibleInGroup Determines whether the current field is visible within the group that owns it.
    Width Specifies the field header’s width in pixels.

    Methods

    Name Description
    ApplyBestFit Resizes the headers and data cells that correspond to the current field to the minimum width required to completely display their contents.
    Assign(TPersistent) Inherited from TPersistent.
    AssignTo(TPersistent) Inherited from TPersistent.
    BeginInvoke(TAsyncConstArrayFunctionEvent,Untyped[],TObject) Inherited from TComponent.
    BeginInvoke(TAsyncConstArrayProc,Untyped[],TObject) Inherited from TComponent.
    BeginInvoke(TAsyncConstArrayProcedureEvent,Untyped[],TObject) Inherited from TComponent.
    BeginInvoke(TAsyncFunctionEvent,TObject) Inherited from TComponent.
    BeginInvoke(TAsyncProcedureEvent,TObject) Inherited from TComponent.
    BeginInvoke(TProc,TObject) Inherited from TComponent.
    BeginInvoke<TResult>(TAsyncConstArrayFunc<TResult>,Untyped[],TObject) Inherited from TComponent.
    BeginInvoke<TResult>(TFunc<TResult>,TObject) Inherited from TComponent.
    CollapseAll Collapses all the columns or rows that correspond to the current field.
    DestroyComponents Inherited from TComponent.
    Destroying Inherited from TComponent.
    EndFunctionInvoke(IAsyncResult) Inherited from TComponent.
    EndInvoke(IAsyncResult) Inherited from TComponent.
    EndInvoke<TResult>(IAsyncResult) Inherited from TComponent.
    Equals(TObject) Inherited from TObject.
    ExecuteAction(TBasicAction) Inherited from TComponent.
    ExpandAll Expands all the columns or rows that correspond to the current field.
    FindComponent(String) Inherited from TComponent.
    FreeNotification(TComponent) Inherited from TComponent.
    FreeOnRelease Inherited from TComponent.
    GetChildren(TGetChildProc,TComponent) Inherited from TComponent.
    GetGroupValue(Integer) Determines the grouping value that corresponds to a particular field value of the current field.
    GetGroupValueDisplayText(Variant) Determines the display text for a particular grouping value.
    GetHashCode Inherited from TObject.
    GetNamePath Inherited from TPersistent.
    GetOwner Inherited from TPersistent.
    GetParentComponent Inherited from TComponent.
    HasParent Inherited from TComponent.
    InsertComponent(TComponent) Inherited from TComponent.
    IsFiltered
    IsImplementorOf(IInterface) Inherited from TComponent.
    Loaded Inherited from TComponent.
    Notification(TComponent,TOperation) Inherited from TComponent.
    ReferenceInterface(IInterface,TOperation) Inherited from TComponent.
    RemoveComponent(TComponent) Inherited from TComponent.
    RemoveFreeNotification(TComponent) Inherited from TComponent.
    SetAreaPosition(TcxPivotGridFieldArea,Integer) Positions the current field in the specified area and at the specified location.
    SetParentComponent(TComponent) Inherited from TComponent.
    SetSubComponent(Boolean) Inherited from TComponent.
    ToString Inherited from TObject.
    UpdateAction(TBasicAction) Inherited from TComponent.

    Events

    Name Description
    OnCalculateCustomSummary Occurs when a summary value needs to be calculated manually.
    OnGetDisplayText Allows you to customize text in the data cell that corresponds to the pivot grid field.
    OnGetGroupImageIndex Occurs when an image is associated with a grouping item.
    OnGetGroupValue Occurs when a grouping value for a field value is to be determined.
    OnGetGroupValueDisplayText Allows you to customize a grouping value‘s text that corresponds to the pivot grid field.
    OnGetProperties Allows you to change the active editor and customize its settings depending on specific conditions.
    OnGetStoredProperties Enables you to customize a list of the current field’s properties to be stored to external data stores.
    OnGetStoredPropertyValue Enables you to provide values for field properties to be saved to external data stores.
    OnGetTotalDisplayText Enables you to customize the text displayed in total headers that correspond to the current field.
    OnSetStoredPropertyValue Enables you to restore the current field’s property values from external data stores.
    PropertiesEvents
    See Also