Back to Devexpress

PivotGridField Properties

wpf-devexpress-dot-xpf-dot-pivotgrid-dot-pivotgridfield-dot-underscore-properties.md

latest52.1 KB
Original Source

PivotGridField Properties

Represents a Pivot Grid field.

NameDescription
ActualCellTemplateGets the template actually used to display the cells of the current field. This is a dependency property.
ActualCellTemplateSelectorGets the actual template selector that chooses a cell template based on custom logic. This is a dependency property.
ActualHeaderContentStyleGets the style actually applied to the field header. This is a dependency property.
ActualHeaderListTemplateGets the template actually used to display the field header in the Field List when headers are arranged in a list. This is a dependency property.
ActualHeaderListTemplateSelectorGets the actual template selector that chooses a template used to display the field header in the Field List when headers are arranged in a list. This is a dependency property.
ActualHeaderTemplateGets the template actually used to display the header of the current field. This is a dependency property.
ActualHeaderTemplateSelectorGets the actual template selector that chooses a field header template based on custom logic. This is a dependency property.
ActualHeaderTreeViewTemplateGets the template actually used to display the field header in the Field List when headers are arranged in a tree. This is a dependency property.
ActualHeaderTreeViewTemplateSelectorGets the actual template selector that chooses a template, used to display the field header in the Field List when headers are arranged in a tree. This is a dependency property.
ActualKpiGraphicGets a graphic set actually used to indicate KPI values. This is a dependency property.
ActualPrintCellTemplateGets the template actually used to print the cells of the current field. This is a dependency property.
ActualPrintCellTemplateSelectorGets the actual template selector that chooses a print template for data cells based on custom logic. This is a dependency property.
ActualPrintHeaderTemplateGets the template actually used to print the header of the current field. This is a dependency property.
ActualPrintHeaderTemplateSelectorGets the actual template selector that chooses a print template for field headers based on custom logic. This is a dependency property.
ActualPrintValueTemplateGets the template actually used to print the values of the current field. This is a dependency property.
ActualPrintValueTemplateSelectorGets the actual template selector that chooses a print template for field values based on custom logic. This is a dependency property.
ActualValueTemplateGets the template actually used to display the values of the current field. This is a dependency property.
ActualValueTemplateSelectorGets the actual template selector that chooses a field value template based on custom logic. This is a dependency property.
AllowDragGets or sets whether an end-user is allowed to drag the Field Header. This is a dependency property.
AllowDragInCustomizationFormGets or sets whether end-users are allowed to drag field headers between areas in the Field List. This is a dependency property.
AllowDropOverrides the AllowDrop property to hide it. Inherited from DXFrameworkContentElement.
AllowedAreasGets or sets the areas within which the field can be positioned. This is a dependency property.
AllowExpandGets or sets whether an end-user is allowed to expand/collapse the rows or columns which correspond to the current field. This is a dependency property.
AllowExpressionEditorGets or sets whether a user can open the Expression Editor dialog for the current field in the context menu.
AllowFilterGets or sets whether an end-user can apply a filter to the current field. This is a dependency property.
AllowHideGets or sets whether an end user can hide the current field. This is a dependency property.
AllowRuntimeSummaryChangeGets or sets whether an end user can change the data field’s summary type. This is a dependency property.
AllowSortGets or sets whether an end-user can modify the field’s current sort order. This is a dependency property.
AllowSortBySummaryGets or sets whether end-users can sort the current row/column field values by other column/row summary values. This is a dependency property.
AllowUnboundExpressionEditorGets or sets whether end-users can invoke the Expression Editor for the field. This is a dependency property.
AreaGets or sets the area in which the field is displayed. This is a dependency property.
AreaIndexGets or sets the field’s index among the other fields displayed within the same area. This is a dependency property.
AreAnyTouchesCapturedGets a value that indicates whether at least one touch is captured to this element. Inherited from ContentElement.
AreAnyTouchesCapturedWithinGets a value that indicates whether at least one touch is captured to this element or to any child elements in its visual tree. Inherited from ContentElement.
AreAnyTouchesDirectlyOverGets a value that indicates whether at least one touch is pressed over this element. Inherited from ContentElement.
AreAnyTouchesOverGets a value that indicates whether at least one touch is pressed over this element or any child elements in its visual tree. Inherited from ContentElement.
AutoPopulatedPropertiesGet or set a collection of OLAP member properties.
BestFitAreaGets or sets which interface elements are taken into account when calculating optimal width for field columns (or height for rows). This is a dependency property.
BestFitMaxRowCountGets or sets the number of cells taken into account when calculating the optimal width required for a column (or row) to completely display its contents. This is a dependency property.
BestFitModeGets or sets how the optimal width required for a column (or row), to completely display its contents is calculated. This is a dependency property.
BindingGroupOverrides the BindingGroup property, to hide it. Inherited from DXFrameworkContentElement.
CalculateHiddenSummariesAllows you to calculate summary values for hidden data fields. This is a dependency property.
CanDragThis member supports the internal infrastructure and is not intended to be used directly from your code.
CanDragInCustomizationFormThis member supports the internal infrastructure and is not intended to be used directly from your code.
CanHideThis member supports the internal 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. This is a dependency property.
CellFormatGets or sets the string used to format the cells. This is a dependency property.
CellTemplateGets or sets a template used to display cells that correspond to the current field. This is a dependency property.
CellTemplateSelectorGets or sets an object that chooses a cell template based on custom logic. This is a dependency property.
CommandBindingsOverrides the CommandBindings property to hide it. Inherited from DXFrameworkContentElement.
ContextMenuOverrides the ContextMenu property to hide it. Inherited from DXFrameworkContentElement.
CursorOverrides the Cursor property to hide it. Inherited from DXFrameworkContentElement.
CustomExcelStyleFilterPopupTemplateGets or sets a template used to display the Excel-style filter drop-down for the current field. This is a dependency property.
CustomTotalsGets the current field’s custom total collection.
DataBindingGets or sets an object that specifies the Pivot Grid field’s source data.
DataContextGets or sets the data context for an element when it participates in data binding. Inherited from FrameworkContentElement.
DataTypeGets the field’s data type.
DefaultStyleKey protectedGets or sets the key to use to find the style template for this control in themes. Inherited from FrameworkContentElement.
DependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance. Inherited from DependencyObject.
DispatcherGets the Dispatcher this DispatcherObject is associated with. Inherited from DispatcherObject.
DisplayFolderGets or sets the name of the folder in which the field is located. This is a dependency property.
DisplayTextGets the string displayed within the field’s header. This is a dependency property.
DropDownFilterListSizeGets or sets the width and height of the field’s filter dropdown. This is a dependency property.
EmptyCellTextGets the text displayed by an empty cell. This is a dependency property.
EmptyValueTextGets the text used for an empty field value header. This is a dependency property.
ExpandedInFieldsGroupGets or sets the expansion status of the current field if it belongs to a field group. This is a dependency property.
ExpressionFieldNameGets the name by which the field is referred to in unbound expressions.
FieldFilterValuesGets or sets the filter values for the current field.
FieldNameGets or sets the name of the data source field assigned to the current PivotGridField object. This is a dependency property.
FilterPopupModeGets or sets what style of the filter drop-down to use for the current field.
FilterTypeGets or sets a field’s filter type.
FilterValuesGets the filter values for the current field. Use the SetFilterValues, GetFilterValuesExcluded or GetFilterValuesIncluded methods instead.
FocusableOverrides the Focusable property to hide it. Inherited from DXFrameworkContentElement.
FocusVisualStyleOverrides the FocusVisualStyle property to hide it. Inherited from DXFrameworkContentElement.
ForceCursorOverrides the ForceCursor property to hide it. Inherited from DXFrameworkContentElement.
GrandTotalCellFormatGets or sets the string used to format grand total values. This is a dependency property.
GrandTotalTextGets or sets the text displayed within the Grand Total‘s header that corresponds to the current field. This is a dependency property.
GroupGets or sets the group which owns the current field. This is a dependency property.
GroupIndexGets or sets the index of the field in a field group. This is a dependency property.
GroupIntervalGets or sets how the values of the current column or row field are combined into groups. This is a dependency property.
GroupIntervalNumericRangeGets or sets the length of intervals into which field values are grouped. This is a dependency property.
GroupNameGets or sets the group name of the current field.
HasAnimatedPropertiesOverrides the HasAnimatedProperties property to hide it. Inherited from DXFrameworkContentElement.
HasGroupThis member supports the internal infrastructure and is not intended to be used directly from your code. This is a dependency property.
HeaderContentStyleGets or sets a style applied to the field header. This is a dependency property.
HeaderImageGets or sets an image displayed within the Pivot Grid’s field header. This is a dependency property.
HeaderListTemplateGets the template used to display the field header in the Field List when headers are arranged in a list. This is a dependency property.
HeaderListTemplateSelectorGets or sets an object that chooses a template used to display the field header in the Field List when headers are arranged in a list. This is a dependency property.
HeaderTemplateGets or sets a template used to display the header of the current field. This is a dependency property.
HeaderTemplateSelectorGets or sets an object that chooses a field header template based on custom logic. This is a dependency property.
HeaderTreeViewTemplateGets the template used to display the field header in the Field List when headers are arranged in a tree. This is a dependency property.
HeaderTreeViewTemplateSelectorGets or sets an object that chooses a template used to display the field header in the Field List when headers are arranged in a tree. This is a dependency property.
HeightGets or sets the height of rows that correspond to the current field. This is a dependency property.
HideEmptyVariationItemsGets or sets whether the first (empty) column/row that displays variation data for the current data field must be hidden. This is a dependency property.
ImmediateUpdateExcelStyleFilterGets or sets whether the filter is applied as soon as an end-user modifies the text within the Excel-style filter drop-down. This is a dependency property.
InputBindingsOverrides the InputBindings property to hide it. Inherited from DXFrameworkContentElement.
InputScopeOverrides the InputScope property to hide it. Inherited from DXFrameworkContentElement.
IsEnabledOverrides the IsEnabled property to hide it. Inherited from DXFrameworkContentElement.
IsEnabledCore protectedGets a value that becomes the return value of IsEnabled in derived classes. Inherited from ContentElement.
IsFilterButtonVisibleGets whether the filter button is displayed within the field’s header. This is a dependency property.
IsFilteredThis member supports the internal infrastructure and is not intended to be used directly from your code. This is a dependency property.
IsFocusedOverrides the IsFocused property to hide it. Inherited from DXFrameworkContentElement.
IsInitializedGets a value indicating whether this element has been initialized, either by being loaded as Extensible Application Markup Language (XAML), or by explicitly having its EndInit() method called. Inherited from FrameworkContentElement.
IsInputMethodEnabledOverrides the IsInputMethodEnabled property to hide it. Inherited from DXFrameworkContentElement.
IsKeyboardFocusedOverrides the IsKeyboardFocused property to hide it. Inherited from DXFrameworkContentElement.
IsKeyboardFocusWithinOverrides the IsKeyboardFocusWithin property to hide it. Inherited from DXFrameworkContentElement.
IsLoadedGets a value indicating whether this element has been loaded for presentation. Inherited from FrameworkContentElement.
IsMouseCapturedOverrides the IsMouseCaptured property to hide it. Inherited from DXFrameworkContentElement.
IsMouseCaptureWithinOverrides the IsMouseCaptureWithin property to hide it. Inherited from DXFrameworkContentElement.
IsMouseDirectlyOverOverrides the IsMouseDirectlyOver property to hide it. Inherited from DXFrameworkContentElement.
IsMouseOverOverrides the IsMouseOver property to hide it. Inherited from DXFrameworkContentElement.
IsSealedOverrides the IsSealed property to hide it. Inherited from DXFrameworkContentElement.
IsSortButtonVisibleGets whether the sort glyph is displayed within the field’s header. This is a dependency property.
IsStylusCapturedOverrides the IsStylusCaptured property to hide it. Inherited from DXFrameworkContentElement.
IsStylusCaptureWithinOverrides the IsStylusCaptureWithin property to hide it. Inherited from DXFrameworkContentElement.
IsStylusDirectlyOverOverrides the IsStylusDirectlyOver property to hide it. Inherited from DXFrameworkContentElement.
IsStylusOverOverrides the IsStylusOver property to hide it. Inherited from DXFrameworkContentElement.
KpiGraphicGets or sets a graphic set used to indicate KPI values. This is a dependency property.
KpiTypeGets the KPI type. This is a dependency property.
LanguageOverrides the Language property to hide it. Inherited from DXFrameworkContentElement.
MinHeightGets or sets the minimum allowed height of rows that correspond to the current field. This is a dependency property.
MinWidthGets or sets the minimum allowed width of columns that correspond to the current field. This is a dependency property.
NameGets or sets the field’s name.
OlapDimensionCaptionSpecifies the OLAP dimension’s caption displayed in the 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. This is a dependency property.
OlapFilterByUniqueNameGets or sets whether PivotGridControl should take into account OLAP member values or unique names when filtering data in an OLAP mode. This is a dependency property.
OlapFilterUsingWhereClauseGets or sets whether to use the WHERE or subselect clause in an MDX query, when filtering against filter fields in OLAP mode.
OlapUseNonEmptyGets or sets whether the NonEmpty function should be used in MDX queries for the current measure. This is a dependency property.
OverridesDefaultStyleOverrides the OverridesDefaultStyle property to hide it. Inherited from DXFrameworkContentElement.
ParentGets the parent in the logical tree for this element. Inherited from FrameworkContentElement.
PrintCellTemplateGets or sets a template used to print cells that correspond to the current field. This is a dependency property.
PrintCellTemplateSelectorGets or sets a template selector that chooses a print template for data cells based on custom logic. This is a dependency property.
PrintHeaderTemplateGets or sets a template used to print the header of the current field. This is a dependency property.
PrintHeaderTemplateSelectorGets or sets a template selector that chooses a print template for field headers based on custom logic. This is a dependency property.
PrintValueTemplateGets or sets a template used to print values of the current field. This is a dependency property.
PrintValueTemplateSelectorGets or sets a template selector that chooses a print template for field values based on custom logic. This is a dependency property.
ResourcesOverrides the Resources property to hide it. Inherited from DXFrameworkContentElement.
RunningTotalGets or sets whether Running totals are calculated for values in the Data Area that correspond to the current column or row field. This is a dependency property.
SerializedSortByFieldGets or sets the PivotGridField.FieldName of the field whose summary values define the order in which the field’s values are arranged when the pivot grid is serialized.
ShowBlankFilterValuesGets or sets a flag that specifies whether to show blank filter values.
ShowCustomTotalsGets or sets whether Custom Totals that correspond to the current Column Field or Row Field are visible. This is a dependency property.
ShowGrandTotalGets or sets whether grand totals that correspond to the current data field are visible. This is a dependency property.
ShowGroupIntervalNameGets or sets whether the group interval’s name is displayed within the data field’s header. This is a dependency property.
ShowInCustomizationFormGets or sets whether the field’s header is displayed within the field list when the field is hidden. This is a dependency property.
ShowInExpressionEditorGets or sets whether the current field is available in the field list in the Expression Editor.
ShowInFilterEditor
ShowNewValues

Gets or sets whether field values are shown in the datasource after field filtering is configured. This is a dependency property.

| | ShowSummaryTypeName | Gets or sets whether the summary type is displayed within the data field’s header. This is a dependency property. | | ShowTotals | Gets or sets whether automatic totals that correspond to the current data field are visible. This is a dependency property. | | ShowValues | Gets or sets whether data cells that correspond to the current data field are visible. This is a dependency property. | | SortByAttribute | Gets or sets the OLAP member property name by which the pivot grid’s data is sorted. | | SortByConditions | Contains conditions that identify the column or row whose values are sorted. | | SortByCustomTotalSummaryType |

Gets or sets the summary type of custom total values by which the current field values are sorted. This is a dependency property.

| | SortByField | Gets or sets the field whose summary values define the order in which the field’s values are arranged. This is a dependency property. | | SortByFieldName | Gets or sets the PivotGridField.FieldName of the field whose summary values define the order in which the field’s values are arranged. This is a dependency property. | | SortBySummaryType | Gets or sets the summary function type used to calculate the summary values which define the order in which the field’s values are arranged. This is a dependency property. | | SortMode | Specifies the sorting algorithm used to sort field values. This is a dependency property. | | SortOrder | Gets or sets the field sort order. This is a dependency property. | | Style | Gets or sets the style to be used by this element. Inherited from FrameworkContentElement. | | SummaryDisplayType | Gets or sets how a summary value calculated against the current data field is represented in a cell. This is a dependency property. | | SummaryFilterColumnField | Gets or sets the column field that identifies an aggregation level at which to apply the filtering. This is a dependency property. | | SummaryFilterEndValue | Gets or sets the maximum summary value to display. This is a dependency property. | | SummaryFilterMode | Gets or sets whether summary filtering should be applied to the last aggregation level or to the specified one. This is a dependency property. | | SummaryFilterRowField | Gets or sets the row field that identifies an aggregation level at which to apply the filtering. This is a dependency property. | | SummaryFilterStartValue | Gets or sets the minimum summary value to display. This is a dependency property. | | SummaryType | Gets or sets the type of the summary function which is calculated against the current data field. This is a dependency property. | | Tag | Gets or sets the data associated with the field. | | TemplatedParent | Gets a reference to the template parent of this element. This property is not relevant if the element was not created through a template. Inherited from FrameworkContentElement. | | ToolTip | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from DXFrameworkContentElement. | | TopValueCount | Gets or sets an absolute or relative number of field values to be displayed for the current column or row field. This is a dependency property. | | TopValueMode | Gets or sets whether top n values for specified data field are calculated based on all data source records or in the parent category. | | TopValueShowOthers | Gets or sets whether the “Others” item is displayed within the PivotGridControl when the Top N Values feature is enabled. This is a dependency property. | | TopValueType | Gets or sets how the number of Top Values is determined. This is a dependency property. | | TotalCellFormat | Gets or sets the string used to format the total cells. This is a dependency property. | | 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. This is a dependency property. | | TotalValueFormat | Gets or sets the string used to format the total header. This is a dependency property. | | TouchesCaptured | Gets all touch devices that are captured to this element. Inherited from ContentElement. | | TouchesCapturedWithin | Gets all touch devices that are captured to this element or any child elements in its visual tree. Inherited from ContentElement. | | TouchesDirectlyOver | Gets all touch devices that are over this element. Inherited from ContentElement. | | TouchesOver | Gets all touch devices that are over this element or any child elements in its visual tree. Inherited from ContentElement. | | TreeViewHeaderImage | Gets or sets an image displayed within the field header in the Field List. | | UnboundExpression | Gets or sets an expression used to evaluate values for the current unbound field. This is a dependency property. | | UnboundExpressionMode | Gets or sets how the unbound expression for the specified data field is calculated. | | UnboundFieldName | Gets or sets the name of a column in a summary data source that corresponds to the current unbound field. This is a dependency property. | | UnboundType | Gets or sets the data type and binding mode of the field. This is a dependency property. | | UseNativeFormat | Gets or sets whether to use the current field’s data format when the Pivot Grid Control is exported in XLS format. This is a dependency property. | | ValueFormat | Gets or sets a string used to format field values. This is a dependency property. | | ValueTemplate | Gets or sets a template used to display values of the current field. This is a dependency property. | | ValueTemplateSelector | Gets or sets an object that chooses a field value template based on custom logic. This is a dependency property. | | Visible | Gets or sets whether the field is visible. This is a dependency property. | | Width | Gets or sets the width of columns that correspond to the current field. This is a dependency property. |

See Also

PivotGridField Class

PivotGridField Members

DevExpress.Xpf.PivotGrid Namespace