Skip to main content
BuyLog In
VCL
Search in…
Docs > VCL Controls > ExpressPivotGrid Suite > API Reference > cxCustomPivotGrid > TcxPivotGridOLAPField > Members
All docs
V24.2
VCL Controls
What's New
Express Cross Platform Library
ExpressQuantumGrid Suite
ExpressEditors Library
ExpressBars Suite
ExpressCharts 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
EcxPivotGrid
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
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
Members
Constructors
Properties
Methods
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
cxPivotGridCustomization
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

TcxPivotGridOLAPField Members

A Pivot Grid field designed for OLAP Mode.

Constructors

Name Description
Create(TComponent) Inherited from TComponent.

Properties

Name Description
ActualWidth Returns the on-screen field‘s width in pixels. Inherited from TcxPivotGridField.
AllowedAreas Specifies areas where the field can be positioned. Inherited from TcxPivotGridField.
Area Specifies the area in which the field is displayed. Inherited from TcxPivotGridField.
AreaIndex Specifies the position of the field amongst the other fields within the same area. Inherited from TcxPivotGridField.
Caption Specifies the field’s display caption. Inherited from TcxPivotGridField.
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. Inherited from TcxPivotGridField.
DataBinding Specifies an object which links the current field to data storage. Inherited from TcxPivotGridField.
DataVisibility Specifies the cell visibility for data fields. Inherited from TcxPivotGridField.
DesignInfo Inherited from TComponent.
DimensionUniqueName Determines the dimension name.
DisplayFormat Specifies the formatting pattern used to display field values. Inherited from TcxPivotGridField.
FieldInCompactLayout Inherited from TcxPivotGridField.
FieldType Determines the field type.
Filter Provides access to the filter applied to the current field. Inherited from TcxPivotGridField.
Group Specifies the group in which the field is contained. Inherited from TcxPivotGridField.
GroupExpanded Specifies the expansion state of the field in a group. Inherited from TcxPivotGridField.
GroupIndex Specifies the index of the group in which the field is contained. Inherited from TcxPivotGridField.
GroupInterval Specifies how the values of the current column field or row field are combined into groups. Inherited from TcxPivotGridField.
GroupIntervalAdvanced Inherited from TcxPivotGridField.
GroupIntervalRange Specifies the length of the intervals when values are grouped together. Inherited from TcxPivotGridField.
GroupValueList Provides indexed access to the list of the field’s grouping values. Inherited from TcxPivotGridField.
Hidden Specifies whether the field is displayed within the customization form. Inherited from TcxPivotGridField.
HierarchyUniqueName Determines the hierarchical path to the field.
ImageAlign Specifies the alignment of an image within the header of the current field. Inherited from TcxPivotGridField.
ImageIndex Specifies the index of an image associated with the field. Inherited from TcxPivotGridField.
Index Specifies the position of the current field within the control’s field collection. Inherited from TcxPivotGridField.
IsCaptionAssigned Inherited from TcxPivotGridField.
IsHierarchy

In OLAP mode, determines whether the current field is associated with a cube hierarchy’s element.

This property is for internal use only.

Inherited from TcxPivotGridField.
IsLastVisibleInArea Inherited from TcxPivotGridField.
IsMeasure Determines whether the field is a measure.
KPIType Determines the KPI type.
LevelNumber
LevelUniqueName Determines the field level name.
MinWidth Specifies the minimum field‘s width in pixels. Inherited from TcxPivotGridField.
Name Inherited from TComponent.
Observers Inherited from TComponent.
Options Specifies field settings.
Owner Inherited from TComponent.
PivotGrid Specifies the pivot grid control that owns the current field. Inherited from TcxPivotGridField.
Properties Provides access to active editor settings. Inherited from TcxPivotGridField.
PropertiesClass Specifies a reference to the editor properties class that corresponds to the active editor type. Inherited from TcxPivotGridField.
PropertiesClassName Specifies the active editor type by its class name. Inherited from TcxPivotGridField.
RecordCount Returns the total number of records that provide data for the field. Inherited from TcxPivotGridField.
RepositoryItem Specifies an edit repository item component for the pivot grid field. Inherited from TcxPivotGridField.
SortBySummaryInfo Specifies the options used to sort the values of the current column field and row field by grand total summary values. Inherited from TcxPivotGridField.
SortedBySummary Indicates whether the values of the current field are sorted by the grand total summary values of a data field. Inherited from TcxPivotGridField.
SortMode Specifies how field values are sorted.
SortOrder Specifies the field‘s sort order. Inherited from TcxPivotGridField.
Styles Represents style settings for the current field’s visual elements. Inherited from TcxPivotGridField.
SummaryIndex Determines the position of the current field within the SummaryFields collection. Inherited from TcxPivotGridField.
SummaryType Specifies the type of the summary function which is calculated against the current field’s values. Inherited from TcxPivotGridField.
SummaryVariation Specifies how a summary value that is calculated against the current data field is represented in a data cell. Inherited from TcxPivotGridField.
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. Inherited from TcxPivotGridField.
TopValueShowOthers Specifies whether the ‘Others’ item is displayed in the pivot grid when the Top N Values feature is enabled. Inherited from TcxPivotGridField.
TotalsVisibility Specifies the type of the totals calculated and displayed within the pivot grid for the current field. Inherited from TcxPivotGridField.
UniqueName In OLAP mode, specifies the full name of a cube element that is bound to the current field. Inherited from TcxPivotGridField.
Values Provides access to the values of the current field. Inherited from TcxPivotGridField.
VCLComObject Inherited from TComponent.
Visible Specifies whether the current field is displayed within the pivot grid. Inherited from TcxPivotGridField.
VisibleIndex Inherited from TcxPivotGridField.
VisibleInGroup Determines whether the current field is visible within the group that owns it. Inherited from TcxPivotGridField.
Width Specifies the field header’s width in pixels. Inherited from TcxPivotGridField.

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. Inherited from TcxPivotGridField.
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. Inherited from TcxPivotGridField.
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. Inherited from TcxPivotGridField.
FilteredValueCount(TcxPivotGridField,Boolean) Returns the number of filter values.
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. Inherited from TcxPivotGridField.
GetGroupValueDisplayText(Variant) Determines the display text for a particular grouping value. Inherited from TcxPivotGridField.
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 Inherited from TcxPivotGridField.
IsImplementorOf(IInterface) Inherited from TComponent.
Loaded Inherited from TComponent.
Notification(TComponent,TOperation) Inherited from TComponent.
PopulateFilteredValues(TcxPivotGridField,Boolean) Populates a list of filter values.
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. Inherited from TcxPivotGridField.
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. Inherited from TcxPivotGridField.
OnGetDisplayText Allows you to customize text in the data cell that corresponds to the pivot grid field. Inherited from TcxPivotGridField.
OnGetGroupImageIndex Occurs when an image is associated with a grouping item. Inherited from TcxPivotGridField.
OnGetGroupValue Occurs when a grouping value for a field value is to be determined. Inherited from TcxPivotGridField.
OnGetGroupValueDisplayText Allows you to customize a grouping value‘s text that corresponds to the pivot grid field. Inherited from TcxPivotGridField.
OnGetProperties Allows you to change the active editor and customize its settings depending on specific conditions. Inherited from TcxPivotGridField.
OnGetStoredProperties Enables you to customize a list of the current field’s properties to be stored to external data stores. Inherited from TcxPivotGridField.
OnGetStoredPropertyValue Enables you to provide values for field properties to be saved to external data stores. Inherited from TcxPivotGridField.
OnGetTotalDisplayText Enables you to customize the text displayed in total headers that correspond to the current field. Inherited from TcxPivotGridField.
OnSetStoredPropertyValue Enables you to restore the current field’s property values from external data stores. Inherited from TcxPivotGridField.
PropertiesEvents Inherited from TcxPivotGridField.
See Also