Skip to main content
A newer version of this page is available. .

XRPivotGridField Properties

Represents a field within the XRPivotGrid control.
Name Description
ActualDataType Gets the field’s actual data type. Inherited from PivotGridFieldBase.
ActualSortMode This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase.
AllowedAreas Gets or sets the areas within which the field can be positioned. Inherited from PivotGridFieldBase.
AnnotationAttributes Returns the object that contains current values for all existing Data Annotation Attributes. Inherited from PivotGridFieldBase.
Appearance Provides access to the appearance settings used to paint the field’s header, values and value totals.
Area Gets or sets the area in which the field is displayed. Inherited from PivotGridFieldBase.
AreaIndex Gets or sets the field’s index from among the other fields displayed within the same area. Inherited from PivotGridFieldBase.
AutoPopulatedProperties Get or set a collection of OLAP member properties. Inherited from PivotGridFieldBase.
CalculateHiddenSummaries Allows you to calculate summary values for hidden data fields. Inherited from PivotGridFieldBase.
CalculateTotals For internal use. Inherited from PivotGridFieldBase.
Calculations Reserved for future use. Inherited from PivotGridFieldBase.
CanDrag This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase.
CanDragInCustomizationForm This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase.
CanFilter This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase.
CanHide This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase.
CanHideEmptyVariationItems Gets whether the first (empty) column/row for the current data field must be hidden (the field’s PivotGridFieldBase.SummaryDisplayType is set to PivotSummaryDisplayType.AbsoluteVariation or PivotSummaryDisplayType.PercentVariation). Inherited from PivotGridFieldBase.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
CanShowInCustomizationForm Gets whether the field can be displayed within the customization form. Inherited from PivotGridFieldBase.
CanShowInPrefilter Gets whether the current field can be filtered via the Prefilter. Inherited from PivotGridFieldBase.
CanSort This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase.
CanSortBySummary Gets whether the current field’s values can be sorted by values in other columns/rows. Inherited from PivotGridFieldBase.
CanSortCore For internal use. Inherited from PivotGridFieldBase.
CanSortOLAP For internal use. Inherited from PivotGridFieldBase.
Caption Gets or sets the field’s display caption. Inherited from PivotGridFieldBase.
CellFormat Provides access to the format settings applied to cells. Inherited from PivotGridFieldBase.
ColumnHandle Obsolete. Gets the field’s unique identifier. Inherited from PivotGridFieldBase.
ColumnValueLineCount If the current field is displayed in the Column Header Area, this property gets or sets the height of the field’s values, in text lines. Inherited from PivotGridFieldBase.
Container Gets the IContainer that contains the Component. Inherited from Component.
CustomTotals Gets the collection of custom totals for the current field.
DataControllerColumnName Returns the column name in the associated data controller. Inherited from PivotGridFieldBase.
DataType Gets the field’s data type. Inherited from PivotGridFieldBase.
DefaultDateFormat static Provides access to global formatting settings for date/time values. Inherited from PivotGridFieldBase.
DefaultDecimalFormat static Provides access to global formatting settings for decimal values. Inherited from PivotGridFieldBase.
DefaultPercentFormat static Provides access to global formatting settings for percent values. Inherited from PivotGridFieldBase.
DefaultTotalFormat static Provides access to global format settings for total values. Inherited from PivotGridFieldBase.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayFolder Gets or sets the name of the folder containing the field. Inherited from PivotGridFieldBase.
DrillDownColumnName For internal use. Inherited from PivotGridFieldBase.
EmptyCellText Gets the text displayed by an empty cell. Inherited from PivotGridFieldBase.
EmptyValueText Gets the text used for an empty field value header. Inherited from PivotGridFieldBase.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
ExpandedInFieldsGroup Gets or sets the expansion status of the current field if it belongs to a field group. Inherited from PivotGridFieldBase.
ExpressionFieldName Gets the field’s name in unbound expressions. Inherited from PivotGridFieldBase.
ExpressionOperator Gets the criteria operator used to evaluate values for the current unbound field. Inherited from PivotGridFieldBase.
FieldName Gets or sets the name of the database field that is assigned to the current Pivot Grid field.
FilterColumnName Gets the column name mapped to the field in the filter control’s view model. For internal use. Inherited from PivotGridFieldBase.
FilterValues Gets or sets filter values for the current field. Inherited from PivotGridFieldBase.
GrandTotalCellFormat Provides access to the format settings applied to grand total values. Inherited from PivotGridFieldBase.
GrandTotalText Gets or sets the text displayed within the Grand Total‘s header that corresponds to the current field. Inherited from PivotGridFieldBase.
Group Gets the group which owns the current field. Inherited from PivotGridFieldBase.
GroupFilterMode Gets the filtering mode used for the field’s owner group. Inherited from PivotGridFieldBase.
GroupIndex Gets the index of the field group which owns the current field. Inherited from PivotGridFieldBase.
GroupInterval Gets or sets how the values of the current column or row field are combined into groups. Inherited from PivotGridFieldBase.
GroupIntervalNumericRange Gets or sets the length of the intervals when values are grouped together. Inherited from PivotGridFieldBase.
HasNullValues Gets whether the field has null values. Inherited from PivotGridFieldBase.
HeaderDisplayText Returns the string displayed within the field’s header, taking into account the field’s PivotGridFieldBase.Caption and the PivotGridFieldBase.SummaryType. The field’s summary type is appended to the field’s Caption if the PivotGridFieldOptions.ShowSummaryTypeName property is enabled. Inherited from PivotGridFieldBase.
Hierarchy Gets the hierarchy to which the dimension level represented by the current field belongs. Inherited from PivotGridFieldBase.
Index Gets or sets the index of the field in the control’s field collection. Inherited from PivotGridFieldBase.
InnerGroupIndex Gets the index of the field in a field group. Inherited from PivotGridFieldBase.
InvalidPropertyDisplayText static For internal use. Inherited from PivotGridFieldBase.
IsColumn Gets whether the field is displayed within the Column Header Area. Inherited from PivotGridFieldBase.
IsColumnOrRow Gets whether the current field is displayed within the Column Header Area or Row Header Area. Inherited from PivotGridFieldBase.
IsComplex Gets whether the current PivotGridFieldBase object is bound to a complex field (a complex field name is constructed in the form “String1.String2” or “String1,String2.String3”, etc). Inherited from PivotGridFieldBase.
IsDataField This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase.
IsDesignTime Gets a value that indicates whether the component is in design mode. Inherited from PivotGridFieldBase.
IsGroupIntervalNumeric Gets whether field values are grouped into numeric intervals as defined by the PivotGridFieldBase.GroupInterval property. Inherited from PivotGridFieldBase.
IsLoading Gets or sets whether the field is being loaded. Inherited from PivotGridFieldBase.
IsNew This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase.
IsNextVisibleFieldInSameGroup This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase.
IsOLAPField Gets whether the field’s FieldName follows the OLAP field naming convention. Inherited from PivotGridFieldBase.
IsOLAPNotSorted This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase.
IsOLAPSorted This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase.
IsOLAPSortModeNone This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase.
IsRowTreeField For internal use. Inherited from PivotGridFieldBase.
IsUnbound For internal use. Inherited from PivotGridFieldBase.
IsUnboundExpression For internal use. Inherited from PivotGridFieldBase.
IsUnboundExpressionValid Gets whether the PivotGridFieldBase.UnboundExpression property’s value specifies a valid expression. Inherited from PivotGridFieldBase.
IsValidForPrefilter For internal use. Inherited from PivotGridFieldBase.
KPIGraphic Gets or sets a graphic set used to indicate KPI values. Inherited from PivotGridFieldBase.
KPIType Gets the KPI type. Inherited from PivotGridFieldBase.
MinWidth Gets or sets the minimum allowed width of columns that correspond to the current field. Inherited from PivotGridFieldBase.
Name Gets or sets the field’s name. Inherited from PivotGridFieldBase.
NamePrefix static Gets the prefix that is used to create field names at design time. Inherited from PivotGridFieldBase.
OLAPDimensionCaption Specifies the OLAP dimension’s caption displayed in the Customization form’s field list. Inherited from PivotGridFieldBase.
OLAPDrillDownColumnName In OLAP mode, gets the name of the corresponding column in the underlying data source, on an OLAP server. Inherited from PivotGridFieldBase.
OLAPExpression Gets or sets an expression used to evaluate values for the current unbound field in OLAP. Inherited from PivotGridFieldBase.
Options Contains the field’s options.
PrefilterColumnName Gets the name by which the field is referred to in the Prefilter expression. Inherited from PivotGridFieldBase.
PropertyDescriptor This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase.
RowValueLineCount If the current field is displayed in the Row Header Area, this property gets or sets the height of the field’s values, in text lines. Inherited from PivotGridFieldBase.
RunningTotal Gets or sets whether Running totals are calculated for values in the Data Area that correspond to the current column or row field. Inherited from PivotGridFieldBase.
SelectedAtDesignTime Gets or sets whether the component is selected at design time. Inherited from PivotGridFieldBase.
ShowActiveFilterButton Gets whether the Filter Button is displayed as active. Inherited from PivotGridFieldBase.
ShowFilterButton Gets whether the Filter Button is visible within the current field’s header. Inherited from PivotGridFieldBase.
ShowNewValues Gets or sets whether field values that have appeared in the datasource after the field’s filtering was configured should be shown. Inherited from PivotGridFieldBase.
ShowSortButton Gets whether the Sort Button is visible in the current field’s header. Inherited from PivotGridFieldBase.
Site Gets or sets the ISite of the Component. Inherited from Component.
SortByAttribute Gets or sets the OLAP member property name by which the pivot grid’s data is sorted. Inherited from PivotGridFieldBase.
SortBySummaryInfo Contains the settings used to sort the values of the current column field or row field by summary values in rows/columns. Inherited from PivotGridFieldBase.
SortMode Gets or sets how the field’s data is sorted when sorting is applied to it. Inherited from PivotGridFieldBase.
SortOrder Gets or sets the field’s sort order. Inherited from PivotGridFieldBase.
SummaryColumnName For internal use. Inherited from PivotGridFieldBase.
SummaryDisplayType Gets or sets how a summary value calculated against the current data field is represented in a cell. Inherited from PivotGridFieldBase.
SummaryFilter Gets summary filtering settings. Inherited from PivotGridFieldBase.
SummaryType Gets or sets the type of the summary function which is calculated against the current data field. Inherited from PivotGridFieldBase.
Tag Gets or sets the data associated with the field. Inherited from PivotGridFieldBase.
TopValueCount Gets or sets the absolute or relative number of field values that should be displayed for the current column field or row field. Inherited from PivotGridFieldBase.
TopValueMode Gets or sets whether top n values for a specified data field are calculated based on all data source records or in the parent category. Inherited from PivotGridFieldBase.
TopValueShowOthers Gets or sets whether the “Others” item is displayed within the Pivot Grid when the Top X Value feature is enabled. Inherited from PivotGridFieldBase.
TopValueType Gets or sets how the number of Top Values is determined. Inherited from PivotGridFieldBase.
TotalCellFormat Provides access to the format settings applied to total cells. Inherited from PivotGridFieldBase.
TotalsVisibility Gets or sets whether to display totals for the current field when it is in the Column Header Area or Row Header Area and if so, whether they are automatic or custom. Inherited from PivotGridFieldBase.
TotalValueFormat Provides access to the format settings applied to the total header. Inherited from PivotGridFieldBase.
UnboundExpression Gets or sets an expression used to evaluate the unbound field’s value. Inherited from PivotGridFieldBase.
UnboundExpressionMode Gets or sets how the specified data field’s unbound expression is calculated. Inherited from PivotGridFieldBase.
UnboundFieldName Gets or sets the name of a column in a summary data source that corresponds to the current unbound field. Inherited from PivotGridFieldBase.
UnboundType Gets or sets the field’s data type and binding mode. Inherited from PivotGridFieldBase.
UseDecimalValuesForMaxMinSummary For internal use. Inherited from PivotGridFieldBase.
UseNativeFormat Gets or sets whether to use the current field’s data format when the Pivot Grid Control is exported in XLS/XLSX formats. Inherited from PivotGridFieldBase.
ValueFormat Provides access to the format settings applied to field values. Inherited from PivotGridFieldBase.
Visible Gets or sets whether the field is visible. Inherited from PivotGridFieldBase.
Width Gets or sets the width of columns that correspond to the current field. Inherited from PivotGridFieldBase.
See Also