Back to Devexpress

PivotGridControl Properties

windowsforms-devexpress-dot-xtrapivotgrid-dot-pivotgridcontrol-dot-underscore-properties.md

latest47.3 KB
Original Source

PivotGridControl Properties

Allows you to create a pivot table (cross-tabular format) for multi-dimensional analysis of large amounts of data.

NameDescription
AccessibilityObjectGets the AccessibleObject assigned to the control. Inherited from Control.
AccessibleDefaultActionDescriptionGets or sets the default action description of the control for use by accessibility client applications. Inherited from Control.
AccessibleDescriptionGets or sets the description of the control used by accessibility client applications. Inherited from Control.
AccessibleNameGets or sets the name of the control used by accessibility client applications. Inherited from Control.
AccessibleRoleGets or sets the accessible role of the control. Inherited from Control.
ActiveEditorGets the PivotGrid’s active editor.
ActiveFilterProvides access to settings of the filter applied to the PivotGridControl‘s data.
ActiveFilterCriteriaGets or sets the filter criteria applied to the PivotGridControl‘s data.
ActiveFilterEnabledGets or sets whether to apply the filter criteria specified using the PivotGridControl.ActiveFilterCriteria or PivotGridControl.ActiveFilterString.
ActiveFilterStringGets or sets a string that specifies the filter criteria applied to the PivotGridControl‘s data.
AllowDropGets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control.
AllowTouchGesturesGets or sets whether the EditorContainer allows touch gestures when the app runs on touch-enabled devices. Inherited from EditorContainer.
AnchorGets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. Inherited from Control.
AppearanceProvides access to the properties that control the appearance of the PivotGrid control’s elements.
AppearancePrintProvides access to the properties that specify the appearances of the PivotGrid control’s elements when it’s printed.
AutoScrollOffsetGets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control.
AutoSizeThis property is not relevant for this class. Inherited from Control.
BackColorGets or sets the control’s background color. Inherited from EditorContainer.
BackgroundImageThis member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
BackgroundImageLayoutThis member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
BindingContextGets or sets the BindingContext for the control. Inherited from Control.
BorderStyleGets or sets the border style for the PivotGridControl.
BottomGets the distance, in pixels, between the bottom edge of the control and the top edge of its container’s client area. Inherited from Control.
BoundsGets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. Inherited from Control.
CanEnableIme protectedGets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from Control.
CanFocusGets a value indicating whether the control can receive focus. Inherited from Control.
CanRaiseEvents protectedDetermines if events can be raised on the control. Inherited from Control.
CanSelectGets a value indicating whether the control can be selected. Inherited from Control.
CaptureGets or sets a value indicating whether the control has captured the mouse. Inherited from Control.
CausesValidationGets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. Inherited from Control.
CellsGets the object which contains information on the cells that are displayed by the control.
CheckForIllegalCrossThreadCalls staticGets or sets a value indicating whether to catch calls on the wrong thread that access a control’s Handle property when an application is being debugged. Inherited from Control.
ClientRectangleGets the rectangle that represents the client area of the control. Inherited from Control.
ClientSizeGets or sets the height and width of the client area of the control. Inherited from Control.
CompanyNameGets the name of the company or creator of the application containing the control. Inherited from Control.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContainsFocusGets a value indicating whether the control, or one of its child controls, currently has the input focus. Inherited from Control.
ContextMenuGets or sets the shortcut menu associated with the control. Inherited from Control.
ControlsGets the collection of controls contained within the control. Inherited from Control.
CreatedGets a value indicating whether the control has been created. Inherited from Control.
CreateParams protectedGets the required creation parameters when the control handle is created. Inherited from Control.
CursorGets or sets the cursor that is displayed when the mouse pointer is over the control. Inherited from Control.
CustomizationFormProvides access to the Customization Form.
CustomizationFormBoundsGets or sets the boundaries of the Customization Form.
CustomizationTreeNodeImages staticSpecifies the collection of images identifying nodes in the Customization Form used when the control is in OLAP mode.
CustomizationTreeNodeSvgImages staticGets or sets a vector image that identifies nodes in the Customization Form when the control is in OLAP mode.
DataBindingsGets the data bindings for the control. Inherited from Control.
DataMemberGets or sets the data source member which supplies data to the control.
DataSourceGets or sets the object used as the data source for the current control.
DefaultBackColor staticGets the default background color of the control. Inherited from Control.
DefaultCursor protectedGets or sets the default cursor for the control. Inherited from Control.
DefaultDataProcessingEngine staticGets or sets a default engine used to perform data processing in the pivot grid.
DefaultFilterEditorViewGets or sets the how an end-user can edit criteria in the Filter Editor. This property is obsolete. Use the PivotGridControl.OptionsFilter.DefaultFilterEditorView property instead.
DefaultFont staticGets the default font of the control. Inherited from Control.
DefaultForeColor staticGets the default foreground color of the control. Inherited from Control.
DefaultImeMode protectedGets the default Input Method Editor (IME) mode supported by the control. Inherited from Control.
DefaultMargin protectedGets the space, in pixels, that is specified by default between controls. Inherited from Control.
DefaultMaximumSize protectedGets the length and height, in pixels, that is specified as the default maximum size of a control. Inherited from Control.
DefaultMinimumSize protectedGets the length and height, in pixels, that is specified as the default minimum size of a control. Inherited from Control.
DefaultPadding protectedGets the internal spacing, in pixels, of the contents of a control. Inherited from Control.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayRectangleGets the rectangle that represents the display area of the control. Inherited from Control.
DisposingGets a value indicating whether the base Control class is in the process of disposing. Inherited from Control.
DockGets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. Inherited from Control.
DoubleBuffered protectedGets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. Inherited from Control.
EditValueGets or sets the active editor’s value.
EnabledGets or sets a value indicating whether the control can respond to user interaction. Inherited from Control.
EndUpdateMode staticGets or sets whether the PivotGrid will be immediately redrawn after calling the PivotGridControl.EndUpdate method.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExternalRepositoryGets or sets the external repository of in-place editors. Inherited from EditorContainer.
FieldsProvides access to a PivotGrid control’s field collection.
FixedColumnFieldValuesProvides access to the fixed columns collection.
FixedLineWidthGets or sets the width of pinned columns separators.
FocusedGets a value indicating whether the control has input focus. Inherited from Control.
FontOverrides the base class Font property.
FontHeight protectedGets or sets the height of the font of the control. Inherited from Control.
ForeColorGets or sets the control’s foreground color. Inherited from EditorContainer.
FormatConditionsGets the collection of style format conditions.
FormatRulesGets the collection of style format rules for a PivotGridControl.
GroupsGets the collection of field groups.
HandleGets the window handle that the control is bound to. Inherited from Control.
HasChildrenGets a value indicating whether the control contains one or more child controls. Inherited from Control.
HeaderImagesGets or sets the source of images available for display within field headers.
HeightGets or sets the height of the control. Inherited from Control.
HtmlImagesGets or sets a collection of images which can be used in HTML string displayed in the field headers or values.
ImeModeGets or sets the Input Method Editor (IME) mode of the control. Inherited from Control.
ImeModeBase protectedGets or sets the IME mode of a control. Inherited from Control.
InvokeRequiredGets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. Inherited from Control.
IsAccessibleGets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control.
IsAsyncInProgressGets whether an asynchronous operation is in progress.
IsDesignModeThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EditorContainer.
IsDisposedGets a value indicating whether the control has been disposed of. Inherited from Control.
IsDraggingIndicates whether a field header is being dragged by a user.
IsHandleCreatedGets a value indicating whether the control has a handle associated with it. Inherited from Control.
IsLoadingGets whether the control is being initialized. Inherited from EditorContainer.
IsMirroredGets a value indicating whether the control is mirrored. Inherited from Control.
IsOLAPDataSourceReturns whether a connection string is specified via the PivotGridControl.OLAPConnectionString property, and so the control is bound to a cube in an MS Analysis Services database.
IsPrintingAvailableIndicates whether the Pivot Grid Control can be printed.
IsUpdateLockedGets whether the PivotGridControl has been locked for updating.
LayoutEngineGets a cached instance of the control’s layout engine. Inherited from Control.
LeftGets or sets the distance, in pixels, between the left edge of the control and the left edge of its container’s client area. Inherited from Control.
LeftTopCoordGets or sets the column and row indexes of the data cell displayed in the top left corner.
ListSourceGets the actual data source whose data is displayed within the control.
LoadingPanelVisibleGets or sets whether the animated loading panel that indicates the data load process is displayed.
LocationGets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. Inherited from Control.
LookAndFeelInherited from EditorContainer.
MarginGets or sets the space between controls. Inherited from Control.
MaximumSizeGets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control.
MenuManagerGets or sets an object that controls the look and feel of the popup menus. Inherited from EditorContainer.
MinimumSizeGets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. Inherited from Control.
ModifierKeys staticGets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control.
MouseButtons staticGets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control.
MousePosition staticGets the position of the mouse cursor in screen coordinates. Inherited from Control.
MRUFiltersGets the recently applied filters list (see MRU Filter List article).
NameGets or sets the name of the control. Inherited from Control.
OLAPConnectionStringSpecifies a connection string to a cube in an MS Analysis Services database.
OLAPDataProviderGets or sets which data provider should be used to bind to an OLAP cube.
OptionsBehaviorProvides access to the control’s behavior options.
OptionsChartDataSourceProvides access to the options controlling the display of the PivotGrid control’s data in a chart control.
OptionsCustomizationProvides access to the Pivot Grid Control’s customization options.
OptionsDataProvides access to the Pivot Grid Control’s data specific options.
OptionsDataFieldProvides access to the options which control the presentation of the data fields in the PivotGrid.
OptionsFilterProvides access to the Pivot Grid’s filter options.
OptionsFilterPopupProvides access to options that define the Classic filter popup’s appearance and behavior.
OptionsHintProvides access to the Pivot Grid Control’s hint options.
OptionsLayoutContains options that specify how the Pivot Grid Control layout is stored to/restored from a storage (a stream, XML file or system registry).
OptionsMenuProvides access to the Pivot Grid Control’s menu options.
OptionsOLAPProvides access to the Pivot Grid Control’s OLAP mode specific options.
OptionsPrintProvides access to the Pivot Grid’s appearance and layout options used when printing or exporting the control in WYSIWYG mode.
OptionsSelectionProvides access to the Pivot Grid Control’s selection options.
OptionsViewProvides access to the Pivot Grid Control’s display options.
PaddingGets or sets padding within the control. Inherited from Control.
PaintAppearanceProvides access to the appearance settings currently used to paint the Pivot Grid Control’s elements.
PaintAppearancePrintProvides access to the appearance settings used to paint the Pivot Grid Control’s elements when it’s printed.
ParentGets or sets the parent container of the control. Inherited from Control.
PreferredSizeGets the size of a rectangular area into which the control can fit. Inherited from Control.
ProductNameGets the product name of the assembly containing the control. Inherited from Control.
ProductVersionGets the version of the assembly containing the control. Inherited from Control.
PropagatingImeMode protected staticGets an object that represents a propagating IME mode. Inherited from Control.
RecreatingHandleGets a value indicating whether the control is currently re-creating its handle. Inherited from Control.
RegionGets or sets the window region associated with the control. Inherited from Control.
RenderRightToLeft protectedThis property is now obsolete. Inherited from Control.
RepositoryItemsProvides access to the control’s internal repository of in-place editors. Inherited from EditorContainer.
ResizeRedraw protectedGets or sets a value indicating whether the control redraws itself when resized. Inherited from Control.
RightGets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control.
RightToLeftGets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. Inherited from Control.
ScaleChildren protectedGets a value that determines the scaling of child controls. Inherited from Control.
ScaleFactorThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EditorContainer.
ShowCustomFunctionsGets or sets whether to show custom function-based filters.
ShowFocusCues protectedGets a value indicating whether the control should display focus rectangles. Inherited from Control.
ShowKeyboardCues protectedGets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control.
SiteGets or sets the site of the control. Inherited from Control.
SizeGets or sets the height and width of the control. Inherited from Control.
TabIndexGets or sets the tab order of the control within its container. Inherited from Control.
TabStopGets or sets a value indicating whether the user can give the focus to this control using the TAB key. Inherited from Control.
TagGets or sets the object that contains data about the control. Inherited from Control.
TextGets or sets the string associated with the control.
ToolTipControllerGets or sets the component that controls the behavior and appearance of hints displayed for a container control’s visual elements. Inherited from EditorContainer.
TopGets or sets the distance, in pixels, between the top edge of the control and the top edge of its container’s client area. Inherited from Control.
TopLevelControlGets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. Inherited from Control.
UseDirectXPaintGets or sets whether the DirectX Hardware Acceleration is enabled for this Pivot Grid Control.
UseDisabledStatePainterGets or sets whether the control is painted grayed out, when in the disabled state.
UserActionGets the end-user action performed on the PivotGridControl.
UseWaitCursorGets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control.
ValueImagesGets or sets the source of images that are available for display within field values.
VisibleGets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control.
WidthGets or sets the width of the control. Inherited from Control.
WindowTargetThis property is not relevant for this class. Inherited from Control.

See Also

PivotGridControl Class

PivotGridControl Members

DevExpress.XtraPivotGrid Namespace