Back to Devexpress

PivotGridFieldBase Properties

corelibraries-devexpress-dot-xtrapivotgrid-dot-pivotgridfieldbase-dot-underscore-properties.md

latest20.0 KB
Original Source

PivotGridFieldBase Properties

Represents the base class for the PivotGridField class.

NameDescription
ActualDataTypeGets the field’s actual data type.
ActualSortModeThis member supports the internal infrastructure and is not intended to be used directly from your code.
AllowedAreasGets or sets the areas within which the field can be positioned.
AnnotationAttributesReturns the object that contains current values for all existing Data Annotation Attributes.
AreaGets or sets the area in which the field is displayed.
AreaIndexGets or sets the field’s index from among the other fields displayed within the same area.
AutoPopulatedPropertiesGet or set a collection of OLAP member properties.
CalculateHiddenSummariesAllows you to calculate summary values for hidden data fields.
CanFilterThis member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
CanHideThis member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CanSortThis member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
CanSortBySummaryGets whether the current field’s values can be sorted by values in other columns/rows.
CaptionGets or sets the field’s display caption.
CellFormatProvides access to the format settings applied to cells.
ColumnHandleObsolete. Gets the field’s unique identifier.
ColumnValueLineCountIf 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.
ContainerGets the IContainer that contains the Component. Inherited from Component.
DataBindingGets or sets an object that specifies the Pivot Grid field’s source data.
DataTypeGets the field’s data type.
DefaultDateFormat staticProvides access to global formatting settings for date/time values.
DefaultDecimalFormat staticProvides access to global formatting settings for decimal values.
DefaultPercentFormat staticProvides access to global formatting settings for percent values.
DefaultTotalFormat staticProvides access to global format settings for total values.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayFolderGets or sets the name of the folder containing the field.
DrillDownColumnNameFor internal use.
EmptyCellTextGets the text displayed by an empty cell.
EmptyValueTextGets the text used for an empty field value header.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExpandedInFieldsGroupGets or sets the expansion status of the current field if it belongs to a field group.
ExpressionFieldNameGets the field’s name in unbound expressions.
FieldNameGets or sets the name of the database field that is assigned to the current PivotGridFieldBase object.
FilterColumnNameGets the column name mapped to the field in the filter control’s view model. For internal use.
FilterValuesGets or sets filter values for the current field.
GrandTotalCellFormatProvides access to the format settings applied to grand total values.
GrandTotalTextGets or sets the text displayed within the Grand Total‘s header that corresponds to the current field.
GroupGets the group which owns the current field.
GroupIndexGets the index of the field group which owns the current field.
GroupIntervalGets or sets how the values of the current column or row field are combined into groups.
GroupIntervalNumericRangeGets or sets the length of the intervals when values are grouped together.
HasNullValuesGets whether the field has null values.
HeaderDisplayTextReturns 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.
HierarchyGets the hierarchy to which the dimension level represented by the current field belongs.
InnerGroupIndexGets the index of the field in a field group.
InvalidPropertyDisplayText staticFor internal use.
IsColumnGets whether the field is displayed within the Column Header Area.
IsColumnOrRowGets whether the current field is displayed within the Column Header Area or Row Header Area.
IsDataFieldThis member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
IsUnboundExpressionValidGets whether the PivotGridFieldBase.UnboundExpression property’s value specifies a valid expression.
KPIGraphicGets or sets a graphic set used to indicate KPI values.
KPITypeGets the KPI type.
MinWidthGets or sets the minimum allowed width of columns that correspond to the current field.
NameGets or sets the field’s name.
NamePrefix staticGets the prefix that is used to create field names at design time.
OLAPDimensionCaptionSpecifies the OLAP dimension’s caption displayed in the Customization form’s field list.
OLAPDrillDownColumnNameIn OLAP mode, gets the name of the corresponding column in the underlying data source, on an OLAP server.
OLAPExpressionGets or sets an expression used to evaluate values for the current unbound field in OLAP.
OptionsContains the field’s options.
RowValueLineCountIf 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.
RunningTotalGets or sets whether Running totals are calculated for values in the Data Area that correspond to the current column or row field.
ShowActiveFilterButtonGets whether the Filter Button is displayed as active.
ShowFilterButtonGets whether the Filter Button is visible within the current field’s header.
ShowNewValuesGets or sets whether field values that have appeared in the datasource after the field’s filtering was configured should be shown.
ShowSortButtonGets whether the Sort Button is visible in the current field’s header.
SiteGets or sets the ISite of the Component. Inherited from Component.
SortByAttributeGets or sets the OLAP member property name by which the pivot grid’s data is sorted.
SortBySummaryInfoContains the settings used to sort the values of the current column field or row field by summary values in rows/columns.
SortModeGets or sets how the field’s data is sorted.
SortOrderGets or sets the field’s sort order.
SummaryDisplayTypeGets or sets how a summary value calculated against the current data field is represented in a cell.
SummaryFilterGets summary filtering settings.
SummaryTypeGets or sets the type of the summary function which is calculated against the current data field.
TagGets or sets the data associated with the field.
TopValueCountGets or sets the absolute or relative number of field values that should be displayed for the current column field or row field.
TopValueModeGets or sets whether top n values for a specified data field are calculated based on all data source records or in the parent category.
TopValueShowOthersGets or sets whether the “Others” item is displayed within the Pivot Grid when the Top X Value feature is enabled.
TopValueTypeGets or sets how the number of Top Values is determined.
TotalCellFormatProvides access to the format settings applied to total cells.
TotalsVisibilityGets 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.
TotalValueFormatProvides access to the format settings applied to the total header.
UnboundExpressionGets or sets an expression used to evaluate the unbound field’s value.
UnboundExpressionModeGets or sets how the specified data field’s unbound expression is calculated.
UnboundFieldNameGets or sets the name of a column in a summary data source that corresponds to the current unbound field.
UnboundTypeGets or sets the field’s data type and binding mode.
UseDecimalValuesForMaxMinSummaryFor internal use.
UseNativeFormatGets or sets whether to use the current field’s data format when the Pivot Grid Control is exported in XLS/XLSX formats.
ValueFormatProvides access to the format settings applied to field values.
VisibleGets or sets whether the field is visible.
WidthGets or sets the width of columns that correspond to the current field.

See Also

PivotGridFieldBase Class

PivotGridFieldBase Members

DevExpress.XtraPivotGrid Namespace