Back to Devexpress

DashboardDesigner Members

dashboard-devexpress-dot-dashboardwin-dot-dashboarddesigner-dot-underscore-members.md

latest221.0 KB
Original Source

DashboardDesigner Members

A Dashboard Designer control that constitutes a designer application for creating dashboards.

Constructors

NameDescription
DashboardDesigner()Initializes a new instance of the DashboardDesigner class with default settings.

Fields

NameDescription
ScrollStateAutoScrolling protected staticDetermines the value of the AutoScroll property. Inherited from ScrollableControl.
ScrollStateFullDrag protected staticDetermines whether the user has enabled full window drag. Inherited from ScrollableControl.
ScrollStateHScrollVisible protected staticDetermines whether the value of the HScroll property is set to true. Inherited from ScrollableControl.
ScrollStateUserHasScrolled protected staticDetermines whether the user had scrolled through the ScrollableControl control. Inherited from ScrollableControl.
ScrollStateVScrollVisible protected staticDetermines whether the value of the VScroll property is set to true. Inherited from ScrollableControl.

Properties

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.
ActionOnCloseGets or sets the required action when the currently opened dashboard is being closed.
ActiveControlGets or sets the active control on the container control. Inherited from ContainerControl.
AllowDropGets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control.
AllowEditComponentNameGets or sets whether the DashboardDesigner allows end-users to edit component names.
AllowInspectAggregatedDataGets or sets whether to display aggregated data in the Data Inspector.
AllowInspectRawDataGets or sets whether to display raw data in the Data Inspector.
AllowMaximizeAnimationGets or sets whether to enable the animation when you maximize or restore dashboard items.
AllowMaximizeDashboardItemsGets or sets whether end users can maximize dashboard items.
AllowPrintDashboardGets or sets whether end-users can print or export a dashboard.
AllowPrintDashboardItemsGets or sets whether end-users can print or export dashboard items.
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.
AppearanceGets the appearance settings used to paint the user control. Inherited from XtraUserControl.
AsyncModeSwitches to asynchronous mode.
AutoScaleDimensionsGets or sets the dimensions that the control was designed to. Inherited from ContainerControl.
AutoScaleFactor protectedGets the scaling factor between the current and design-time automatic scaling dimensions. Inherited from ContainerControl.
AutoScaleModeGets or sets the automatic scaling mode of the control. Inherited from ContainerControl.
AutoScrollGets or sets a value indicating whether the container enables the user to scroll to any controls placed outside of its visible boundaries. Inherited from ScrollableControl.
AutoScrollMarginGets or sets the size of the auto-scroll margin. Inherited from ScrollableControl.
AutoScrollMinSizeGets or sets the minimum size of the auto-scroll. Inherited from ScrollableControl.
AutoScrollOffsetGets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control.
AutoScrollPositionGets or sets the location of the auto-scroll position. Inherited from ScrollableControl.
AutoSizeThis property is not relevant for this class. Inherited from UserControl.
AutoSizeModeGets or sets how the control will resize itself. Inherited from UserControl.
AutoValidateGets or sets how the control performs validation when the user changes focus to another control. Inherited from UserControl.
BackColorGets or sets the control’s background color.
BackgroundImageGets or sets the background image displayed in the control. Inherited from Control.
BackgroundImageLayoutGets or sets the background image layout as defined in the ImageLayout enumeration. Inherited from Control.
BarAndDockingControllerGets or sets the BarAndDockingController that will provide default appearance options for the DashboardDesigner‘s elements.
BarManagerGets the BarManager component that is used to manage bars in the Dashboard Designer.
BindingContextGets or sets the BindingContext for the control. Inherited from ContainerControl.
BorderStyleGets or sets the border style of the user control. Inherited from UserControl.
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.
CalculateHiddenTotalsGets or sets whether to calculate totals for the hidden data items.
CanEnableIme protectedGets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from ContainerControl.
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.
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.
ContextMenuStripThis property does not affect the Dashboard Designer.
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 UserControl.
CurrentAutoScaleDimensionsGets the current run-time dimensions of the screen. Inherited from ContainerControl.
CursorGets or sets the cursor that is displayed when the mouse pointer is over the control. Inherited from Control.
CustomDataConnectionsGets the list of custom data connections displayed in the Create Data Source wizard.
CustomDBCommandInterceptorSpecifies the IDBCommandInterceptor object for the Dashboard Designer control.
CustomDBConnectionInterceptorSpecifies the IDBConnectionInterceptor object for the Dashboard Designer control.
CustomDBSchemaProviderExAllows you to specify a custom schema for the SQL Data Source.
DashboardGets or sets the currently opened dashboard.
DashboardFileNameGets the name of the file where the currently opened dashboard is stored.
DataBindingsGets the data bindings for the control. Inherited from Control.
DataSourceOptionsProvides access to options that define the data source options of a DashboardDesigner.
DataSourceWizardAllows you to customize the Data Source wizard used to create new data sources in the DashboardDesigner.
DataSourceWizardCustomizationProvides the capability to customize the Data Source wizard used to create new data sources.
DataSourceWizardCustomizationServiceProvides the capability to customize the Data Source wizard used to create new data sources.
DataSourceWizardSettingsThis property is for internal use. Use the equivalent property DataSourceWizard instead.
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.
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.
DefaultSize protectedGets the default size of the control. Inherited from UserControl.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayRectangleGets the rectangle that represents the virtual display area of the control. Inherited from ScrollableControl.
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.
DockPaddingGets the dock padding settings for all edges of the control. Inherited from ScrollableControl.
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.
EnabledGets or sets a value indicating whether the control can respond to user interaction. Inherited from Control.
EnableIXtraResizeableControlInterfaceProxyThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from XtraUserControl.
EnableWaitFormGets or sets whether the DashboardDesigner displays a Wait Form when a time-consuming operation is performed.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExcelExportOptionsProvides access to options related to exporting a dashboard item to Excel format.
FilterCriteriaDisplayStyleGets or sets the display style of filter conditions in the Filter Editor.
FocusedGets a value indicating whether the control has input focus. Inherited from Control.
FontGets or sets font settings applied to the control. Inherited from XtraUserControl.
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 XtraUserControl.
GridBestFitMaxRowCountGets or sets the number of the Grid dashboard item’s data rows whose content is processed to apply best fit to columns.
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.
HeightGets or sets the height of the control. Inherited from Control.
HorizontalScrollGets the characteristics associated with the horizontal scroll bar. Inherited from ScrollableControl.
HScroll protectedGets or sets a value indicating whether the horizontal scroll bar is visible. Inherited from ScrollableControl.
ImageExportOptionsProvides access to options related to exporting a dashboard/dashboard item to an image.
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.
IsDashboardModifiedGets whether the dashboard has been modified since the last save.
IsDisposedGets a value indicating whether the control has been disposed of. Inherited from Control.
IsHandleCreatedGets a value indicating whether the control has a handle associated with it. Inherited from Control.
IsMirroredGets a value indicating whether the control is mirrored. Inherited from Control.
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.
LoadInactiveTabs
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.
LookAndFeelContains settings that specify the look and feel of the current XtraUserControl and all DevExpress controls placed on it. Inherited from XtraUserControl.
MarginGets or sets the space between controls. Inherited from Control.
MaximizedDashboardItemNameGets the name of the maximized dashboard item.
MaximumSizeGets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control.
MenuManagerGets or sets the menu manager that controls the look and feel of the DashboardDesigner menus.
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.
NameGets or sets the name of the control. Inherited from Control.
PaddingGets or sets padding within the control. Inherited from Control.
ParametersProvides access to dashboard parameter settings and metadata.
ParentGets or sets the parent container of the control. Inherited from Control.
ParentFormGets the form that the container control is assigned to. Inherited from ContainerControl.
PdfExportOptionsProvides access to options related to exporting a dashboard/dashboard item to PDF format.
PopupMenuFor internal use.
PreferredSizeGets the size of a rectangular area into which the control can fit. Inherited from Control.
PrintPreviewOptionsProvides access to options related to printing a dashboard/dashboard item.
PrintPreviewTypeGets or sets the type of Print Preview used to preview dashboard items or the entire dashboard.
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.
RangeFilterIncludeCurrentDateGets or sets whether the current date (year/quarter/month/etc.) is included in the’Last’ and ‘Next’ newly created predefined periods in the Edit Periods dialog.
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.
ResizeRedraw protectedGets or sets a value indicating whether the control redraws itself when resized. Inherited from Control.
RibbonGets a Ribbon instance for the current Dashboard Designer.
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.
SelectedDashboardItemGets or sets the currently selected dashboard item.
SelectedDataMemberGets or sets the currently selected data member.
SelectedDataSourceGets or sets the currently selected data source.
ServiceContainerFor internal use.
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 XtraUserControl. Inherited from XtraUserControl.
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 text associated with this control. Inherited from UserControl.
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.
UseCardLegacyLayoutGets or sets whether to enable the legacy card layout used prior to v17.1.
UseNeutralFilterModeGets or sets whether to show all items in the filter elements deselected by default.
UserActionGets the end-user action performed on the DashboardDesigner.
UseWaitCursorGets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control.
VerticalScrollGets the characteristics associated with the vertical scroll bar. Inherited from ScrollableControl.
VisibleGets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control.
VScroll protectedGets or sets a value indicating whether the vertical scroll bar is visible. Inherited from ScrollableControl.
WidthGets or sets the width of the control. Inherited from Control.
WindowTargetThis property is not relevant for this class. Inherited from Control.

Methods

NameDescription
About() staticActivates the control’s About dialog box.
AccessibilityNotifyClients(AccessibleEvents, Int32, Int32) protectedNotifies the accessibility client applications of the specified AccessibleEvents for the specified child control . Inherited from Control.
AccessibilityNotifyClients(AccessibleEvents, Int32) protectedNotifies the accessibility client applications of the specified AccessibleEvents for the specified child control. Inherited from Control.
AddToHistory(IHistoryItem)Allows you to write an action to history.
AdjustFormScrollbars(Boolean) protectedAdjusts the scroll bars on the container based on the current control positions and the control currently selected. Inherited from ContainerControl.
BeginInit()For internal use.
BeginInvoke(Delegate, Object[])Executes the specified delegate asynchronously with the specified arguments, on the thread that the control’s underlying handle was created on. Inherited from Control.
BeginInvoke(Delegate)Executes the specified delegate asynchronously on the thread that the control’s underlying handle was created on. Inherited from Control.
BeginUpdateParameters()Locks the DashboardParameters object until the DashboardDesigner.EndUpdateParameters method call.
BringToFront()Brings the control to the front of the z-order. Inherited from Control.
CanClearMasterFilter(String)Returns whether the specified master filter can be cleared in the current state.
CanPerformDrillDown(String)Returns whether drill down is possible in the current state of the specified dashboard item.
CanPerformDrillUp(String)Returns whether drill up is possible in the current state of the specified dashboard item.
CanSetMasterFilter(String)Returns whether the master filter item allows users to select one or more elements.
CanSetMultiValueMasterFilter(String)Returns whether the master filter item allows users to select multiple elements.
ClearMasterFilter(String)Clears the specified master filter item.
ClearMasterFilterAsync(String, CancellationToken)Clears the specified master filter item in asynchronous mode.
ClearMasterFilterAsync(String)Clears the specified master filter item in asynchronous mode.
Contains(Control)Retrieves a value indicating whether the specified control is a child of the control. Inherited from Control.
CreateAccessibilityInstance() protectedCreates a new accessibility object for the control. Inherited from Control.
CreateBars()Creates and initializes a toolbar menu in the DashboardDesigner‘s parent control.
CreateControl()Forces the creation of the visible control, including the creation of the handle and any visible child controls. Inherited from Control.
CreateControlsInstance() protectedCreates a new instance of the control collection for the control. Inherited from Control.
CreateCustomItemBars(Type[])Adds custom item bars to the Ribbon.
CreateGraphics()Creates the Graphics for the control. Inherited from Control.
CreateHandle() protectedCreates a handle for the control. Inherited from Control.
CreateObjRef(Type)Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
CreateRibbon()Creates and initializes a Ribbon in the DashboardDesigner‘s parent control.
DefWndProc(Message) protectedSends the specified message to the default window procedure. Inherited from Control.
DestroyHandle() protectedDestroys the handle associated with the control. Inherited from Control.
Dispose()Releases all resources used by the Component. Inherited from Component.
DoDragDrop(Object, DragDropEffects)Begins a drag-and-drop operation. Inherited from Control.
DrawToBitmap(Bitmap, Rectangle)Supports rendering to the specified bitmap. Inherited from Control.
EndInit()For internal use.
EndInvoke(IAsyncResult)Retrieves the return value of the asynchronous operation represented by the IAsyncResult passed. Inherited from Control.
EndUpdateParameters()Unlocks the DashboardParameters object after a call to the DashboardDesigner.BeginUpdateParameters method and applies changes made to the parameter settings.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
ExportDashboardItemToExcel(String, Stream, DashboardExcelExportOptions)Exports the dashboard item to the specified stream in Excel format.
ExportDashboardItemToExcel(String, String, DashboardExcelExportOptions)Exports the dashboard item to the specified file in Excel format using specified export options.
ExportDashboardItemToImage(String, Stream, DashboardImageExportOptions)Exports the dashboard item to the specified stream in Image format using the specified image options.
ExportDashboardItemToImage(String, Stream)Exports the dashboard item to the specified stream in Image format.
ExportDashboardItemToImage(String, String, DashboardImageExportOptions)Exports the dashboard item to the image file using the specified image options.
ExportDashboardItemToImage(String, String)Exports the dashboard item to the specified file in Image format.
ExportDashboardItemToPdf(String, Stream, DashboardPdfExportOptions)Exports the dashboard item to the specified stream in PDF format using the specified PDF-specific options.
ExportDashboardItemToPdf(String, Stream)Exports the dashboard item to the specified stream in PDF format.
ExportDashboardItemToPdf(String, String, DashboardPdfExportOptions)Exports the dashboard item to the specified file in PDF format using the specified PDF-specific options.
ExportDashboardItemToPdf(String, String)Exports the dashboard item to the specified file in PDF format.
ExportToExcel(Stream, DashboardExcelExportOptions)Exports dashboard data to the specified stream in Excel format.
ExportToExcel(Stream)Exports dashboard data to the specified stream in Excel format.
ExportToExcel(String, DashboardExcelExportOptions)Exports dashboard data to the specified file in Excel format.
ExportToExcel(String)Exports dashboard data to the specified file in Excel format.
ExportToImage(Stream, DashboardImageExportOptions)Exports a dashboard to the specified stream in Image format using the specified image-specific options.
ExportToImage(Stream)Exports a dashboard to the specified stream in Image format.
ExportToImage(String, DashboardImageExportOptions)Exports a dashboard to the specified image file using the specified image-specific options.
ExportToImage(String)Exports a dashboard to the specified file in Image format.
ExportToPdf(Stream, DashboardPdfExportOptions)Exports a dashboard to the specified stream in PDF format using the specified PDF-specific options.
ExportToPdf(Stream)Exports a dashboard to the specified stream in PDF format.
ExportToPdf(String, DashboardPdfExportOptions)Exports a dashboard to the specified file in PDF format using the specified PDF-specific options.
ExportToPdf(String)Exports a dashboard to the specified file in PDF format.
FindForm()Retrieves the form that the control is on. Inherited from Control.
Focus()Sets input focus to the control. Inherited from Control.
FromChildHandle(IntPtr) staticRetrieves the control that contains the specified handle. Inherited from Control.
FromHandle(IntPtr) staticReturns the control that is currently associated with the specified handle. Inherited from Control.
GetAccessibilityObjectById(Int32) protectedRetrieves the specified AccessibleObject. Inherited from Control.
GetAutoSizeMode() protectedRetrieves a value indicating how a control will behave when its AutoSize property is enabled. Inherited from Control.
GetAvailableDrillDownValues(String)Returns axis point tuples identifying elements that can be used to perform drill-down in the specified dashboard item.
GetAvailableDrillDownValuesAsync(String)Returns data identifying the elements that can be used to perform drill-down in the specified dashboard item. Asynchronous method.
GetAvailableFilterValues(String)Returns axis point tuples identifying elements that can be selected in the current state of the master filter item.
GetAvailableFilterValuesAsync(String)Gets the data (axis point tuples) that identifies selectable elements in the current state of the master filter item.
GetAvailablePredefinedRanges(String)Returns names of the predefined ranges available for the specified Range Filter.
GetChildAtPoint(Point, GetChildAtPointSkip)Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type. Inherited from Control.
GetChildAtPoint(Point)Retrieves the child control that is located at the specified coordinates. Inherited from Control.
GetContainerControl()Returns the next ContainerControl up the control’s chain of parent controls. Inherited from Control.
GetCurrentDrillDownValues(String)Returns an axis point tuple identifying the current drill-down state.
GetCurrentFilterValues(String)Returns axis point tuples identifying currently selected elements in the master filter item.
GetCurrentPredefinedRange(String)Returns the name of the currently selected predefined range.
GetCurrentRange(String)Returns the selected range for the specified Range Filter or Date Filter dashboard item.
GetCurrentSelection(String)Returns records identifying currently selected elements in the master filter item.
GetDashboardState()Gets the current dashboard state.
GetEntireRange(String)Returns the visible range for the specified Range Filter or Date Filter dashboard item.
GetEntireRangeAsync(String)Returns the visible range for the specified Range Filter or Date Filter dashboard item.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetItemData(String)Returns the client data for the specified dashboard item.
GetItemDataAsync(String)Obtains the displayed data for the specified dashboard item asynchronously.
GetLifetimeService()Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetNextControl(Control, Boolean)Retrieves the next control forward or back in the tab order of child controls. Inherited from Control.
GetPreferredSize(Size)Retrieves the size of a rectangular area into which a control can be fitted. Inherited from Control.
GetPrintableControl(String)Gets a printable control corresponding to the specified dashboard item.
GetScaledBounds(Rectangle, SizeF, BoundsSpecified) protectedRetrieves the bounds within which the control is scaled. Inherited from Control.
GetScrollState(Int32) protectedDetermines whether the specified flag has been set. Inherited from ScrollableControl.
GetSelectedTabPage(String)Gets the selected page in the specified tab container.
GetSelectedTabPageIndex(String)Gets the index of the selected page in the specified tab container.
GetService(Type) protectedReturns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetStyle(ControlStyles) protectedRetrieves the value of the specified control style bit for the control. Inherited from Control.
GetTopLevel() protectedDetermines if the control is a top-level control. Inherited from Control.
GetType()Gets the Type of the current instance. Inherited from Object.
GetUnderlyingControl(String)Gets the underlying control used to visualize data within the specified dashboard item.
GetUnderlyingControls()Gets the underlying controls used to visualize data within the dashboard items.
GetUnderlyingData(String, IList<AxisPoint>, IList<String>)Returns underlying data for the specified dashboard item by the specified axis points.
GetUnderlyingData(String, IList<AxisPoint>)Returns underlying data for the specified dashboard item by the specified axis points.
GetUnderlyingData(String, IList<UnderlyingDataTargetValue>, IList<String>)Returns underlying data for the specified dashboard item by the specified dimension values.
GetUnderlyingData(String, IList<UnderlyingDataTargetValue>)Returns underlying data for the specified dashboard item by the specified dimension values.
GetUnderlyingData(String, IList<String>)Returns underlying data for the specified dashboard item by the specified data members.
GetUnderlyingData(String)Returns a list of records from the dashboard data source for the specified dashboard item.
HandleDashboardClosing()Handles the dashboard close process.
Hide()Conceals the control from the user. Inherited from Control.
InitializeLifetimeService()Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
InitLayout() protectedCalled after the control has been added to another container. Inherited from Control.
Invalidate()Invalidates the entire surface of the control and causes the control to be redrawn. Inherited from Control.
Invalidate(Boolean)Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. Inherited from Control.
Invalidate(Rectangle, Boolean)Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. Inherited from Control.
Invalidate(Rectangle)Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Inherited from Control.
Invalidate(Region, Boolean)Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. Inherited from Control.
Invalidate(Region)Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Inherited from Control.
Invoke(Delegate, Object[])Executes the specified delegate, on the thread that owns the control’s underlying window handle, with the specified list of arguments. Inherited from Control.
Invoke(Delegate)Executes the specified delegate on the thread that owns the control’s underlying window handle. Inherited from Control.
InvokeGotFocus(Control, EventArgs) protectedRaises the GotFocus event for the specified control. Inherited from Control.
InvokeLostFocus(Control, EventArgs) protectedRaises the LostFocus event for the specified control. Inherited from Control.
InvokeOnClick(Control, EventArgs) protectedRaises the Click event for the specified control. Inherited from Control.
InvokePaint(Control, PaintEventArgs) protectedRaises the Paint event for the specified control. Inherited from Control.
InvokePaintBackground(Control, PaintEventArgs) protectedRaises the PaintBackground event for the specified control. Inherited from Control.
IsInputChar(Char) protectedDetermines if a character is an input character that the control recognizes. Inherited from Control.
IsInputKey(Keys) protectedDetermines whether the specified key is a regular input key or a special key that requires preprocessing. Inherited from Control.
IsKeyLocked(Keys) staticDetermines whether the CAPS LOCK, NUM LOCK, or SCROLL LOCK key is in effect. Inherited from Control.
IsMnemonic(Char, String) staticDetermines if the specified character is the mnemonic character assigned to the control in the specified string. Inherited from Control.
LoadDashboard(Stream)Loads a dashboard from a stream.
LoadDashboard(String)Loads a dashboard from an XML file.
LoadDashboardLayout(Stream)Loads a dashboard layout from a stream.
LoadDashboardLayout(String)Loads a dashboard layout from an XML file.
MaximizeDashboardItem(String)Expands the specified dashboard item to the entire dashboard size to examine data in greater detail.
MaximizeDashboardItemAsync(String)Expands the specified dashboard item to the entire dashboard size in an asynchronous task.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
NotifyInvalidate(Rectangle) protectedRaises the Invalidated event with a specified region of the control to invalidate. Inherited from Control.
OnAutoSizeChanged(EventArgs) protectedRaises the AutoSizeChanged event. Inherited from Control.
OnAutoValidateChanged(EventArgs) protectedRaises the AutoValidateChanged event. Inherited from ContainerControl.
OnBackgroundImageChanged(EventArgs) protectedRaises the BackgroundImageChanged event. Inherited from Control.
OnBackgroundImageLayoutChanged(EventArgs) protectedRaises the BackgroundImageLayoutChanged event. Inherited from Control.
OnBindingContextChanged(EventArgs) protectedRaises the BindingContextChanged event. Inherited from Control.
OnCausesValidationChanged(EventArgs) protectedRaises the CausesValidationChanged event. Inherited from Control.
OnChangeUICues(UICuesEventArgs) protectedRaises the ChangeUICues event. Inherited from Control.
OnClick(EventArgs) protectedRaises the Click event. Inherited from Control.
OnClientSizeChanged(EventArgs) protectedRaises the ClientSizeChanged event. Inherited from Control.
OnContextMenuChanged(EventArgs) protectedRaises the ContextMenuChanged event. Inherited from Control.
OnContextMenuStripChanged(EventArgs) protectedRaises the ContextMenuStripChanged event. Inherited from Control.
OnCreateControl() protectedRaises the CreateControl event. Inherited from UserControl.
OnCursorChanged(EventArgs) protectedRaises the CursorChanged event. Inherited from Control.
OnDockChanged(EventArgs) protectedRaises the DockChanged event. Inherited from Control.
OnDoubleClick(EventArgs) protectedRaises the DoubleClick event. Inherited from Control.
OnDragDrop(DragEventArgs) protectedRaises the DragDrop event. Inherited from Control.
OnDragEnter(DragEventArgs) protectedRaises the DragEnter event. Inherited from Control.
OnDragLeave(EventArgs) protectedRaises the DragLeave event. Inherited from Control.
OnDragOver(DragEventArgs) protectedRaises the DragOver event. Inherited from Control.
OnEnabledChanged(EventArgs) protectedRaises the EnabledChanged event. Inherited from Control.
OnEnter(EventArgs) protectedRaises the Enter event. Inherited from Control.
OnFontChanged(EventArgs) protectedRaises the FontChanged event. Inherited from ContainerControl.
OnGiveFeedback(GiveFeedbackEventArgs) protectedRaises the GiveFeedback event. Inherited from Control.
OnGotFocus(EventArgs) protectedRaises the GotFocus event. Inherited from Control.
OnHelpRequested(HelpEventArgs) protectedRaises the HelpRequested event. Inherited from Control.
OnImeModeChanged(EventArgs) protectedRaises the ImeModeChanged event. Inherited from Control.
OnInvalidated(InvalidateEventArgs) protectedRaises the Invalidated event. Inherited from Control.
OnKeyDown(KeyEventArgs) protectedRaises the KeyDown event. Inherited from Control.
OnKeyPress(KeyPressEventArgs) protectedRaises the KeyPress event. Inherited from Control.
OnKeyUp(KeyEventArgs) protectedRaises the KeyUp event. Inherited from Control.
OnLayout(LayoutEventArgs) protectedRaises the Layout event. Inherited from ContainerControl.
OnLeave(EventArgs) protectedRaises the Leave event. Inherited from Control.
OnLocationChanged(EventArgs) protectedRaises the LocationChanged event. Inherited from Control.
OnLostFocus(EventArgs) protectedRaises the LostFocus event. Inherited from Control.
OnMarginChanged(EventArgs) protectedRaises the MarginChanged event. Inherited from Control.
OnMouseCaptureChanged(EventArgs) protectedRaises the MouseCaptureChanged event. Inherited from Control.
OnMouseClick(MouseEventArgs) protectedRaises the MouseClick event. Inherited from Control.
OnMouseDoubleClick(MouseEventArgs) protectedRaises the MouseDoubleClick event. Inherited from Control.
OnMouseDown(MouseEventArgs) protectedRaises the MouseDown event. Inherited from UserControl.
OnMouseEnter(EventArgs) protectedRaises the MouseEnter event. Inherited from Control.
OnMouseHover(EventArgs) protectedRaises the MouseHover event. Inherited from Control.
OnMouseLeave(EventArgs) protectedRaises the MouseLeave event. Inherited from Control.
OnMouseMove(MouseEventArgs) protectedRaises the MouseMove event. Inherited from Control.
OnMouseUp(MouseEventArgs) protectedRaises the MouseUp event. Inherited from Control.
OnMouseWheel(MouseEventArgs) protectedRaises the MouseWheel event. Inherited from ScrollableControl.
OnMove(EventArgs) protectedRaises the Move event. Inherited from Control.
OnNotifyMessage(Message) protectedNotifies the control of Windows messages. Inherited from Control.
OnPaddingChanged(EventArgs) protectedRaises the PaddingChanged event. Inherited from ScrollableControl.
OnPaintBackground(PaintEventArgs) protectedPaints the background of the control. Inherited from ScrollableControl.
OnParentBackColorChanged(EventArgs) protectedRaises the BackColorChanged event when the BackColor property value of the control’s container changes. Inherited from Control.
OnParentBackgroundImageChanged(EventArgs) protectedRaises the BackgroundImageChanged event when the BackgroundImage property value of the control’s container changes. Inherited from Control.
OnParentBindingContextChanged(EventArgs) protectedRaises the BindingContextChanged event when the BindingContext property value of the control’s container changes. Inherited from Control.
OnParentCursorChanged(EventArgs) protectedRaises the CursorChanged event. Inherited from Control.
OnParentEnabledChanged(EventArgs) protectedRaises the EnabledChanged event when the Enabled property value of the control’s container changes. Inherited from Control.
OnParentFontChanged(EventArgs) protectedRaises the FontChanged event when the Font property value of the control’s container changes. Inherited from Control.
OnParentForeColorChanged(EventArgs) protectedRaises the ForeColorChanged event when the ForeColor property value of the control’s container changes. Inherited from Control.
OnParentRightToLeftChanged(EventArgs) protectedRaises the RightToLeftChanged event when the RightToLeft property value of the control’s container changes. Inherited from Control.
OnParentVisibleChanged(EventArgs) protectedRaises the VisibleChanged event when the Visible property value of the control’s container changes. Inherited from Control.
OnPreviewKeyDown(PreviewKeyDownEventArgs) protectedRaises the PreviewKeyDown event. Inherited from Control.
OnPrint(PaintEventArgs) protectedRaises the Paint event. Inherited from Control.
OnQueryContinueDrag(QueryContinueDragEventArgs) protectedRaises the QueryContinueDrag event. Inherited from Control.
OnRegionChanged(EventArgs) protectedRaises the RegionChanged event. Inherited from Control.
OnResize(EventArgs) protectedRaises the Resize event. Inherited from UserControl.
OnScroll(ScrollEventArgs) protectedRaises the Scroll event. Inherited from ScrollableControl.
OnStyleChanged(EventArgs) protectedRaises the StyleChanged event. Inherited from Control.
OnSystemColorsChanged(EventArgs) protectedRaises the SystemColorsChanged event. Inherited from Control.
OnTabIndexChanged(EventArgs) protectedRaises the TabIndexChanged event. Inherited from Control.
OnTabStopChanged(EventArgs) protectedRaises the TabStopChanged event. Inherited from Control.
OnTextChanged(EventArgs) protectedRaises the TextChanged event. Inherited from Control.
OnValidated(EventArgs) protectedRaises the Validated event. Inherited from Control.
OnValidating(CancelEventArgs) protectedRaises the Validating event. Inherited from Control.
OnVisibleChanged(EventArgs) protectedRaises the VisibleChanged event. Inherited from ScrollableControl.
PerformAutoScale()Performs scaling of the container control and its children. Inherited from ContainerControl.
PerformDrillDown(String, DashboardDataRow)Performs a drill-down for the required element.
PerformDrillDown(String, AxisPointTuple)Performs a drill-down for the required element.
PerformDrillDown(String, Object)Performs a drill-down for the required element by its value.
PerformDrillDownAsync(String, DashboardDataRow, CancellationToken)Performs a drill-down for the required element asynchronously.
PerformDrillDownAsync(String, DashboardDataRow)Performs a drill-down for the required element asynchronously.
PerformDrillDownAsync(String, AxisPointTuple, CancellationToken)Performs a drill-down for the required element asynchronously.
PerformDrillDownAsync(String, AxisPointTuple)Performs a drill-down for the required element asynchronously.
PerformDrillDownAsync(String, Object, CancellationToken)Performs a drill-down for the required element by its value, asynchronously.
PerformDrillDownAsync(String, Object)Performs a drill-down for the required element by its value, asynchronously.
PerformDrillUp(String)Performs a drill-up for the specified dashboard item.
PerformDrillUpAsync(String, CancellationToken)Performs a drill-up in the specified dashboard item asynchronously.
PerformDrillUpAsync(String)Performs a drill-up in the specified dashboard item asynchronously.
PerformLayout()Forces the control to apply layout logic to all its child controls. Inherited from Control.
PerformLayout(Control, String)Forces the control to apply layout logic to all its child controls. Inherited from Control.
PointToClient(Point)Computes the location of the specified screen point into client coordinates. Inherited from Control.
PointToScreen(Point)Computes the location of the specified client point into screen coordinates. Inherited from Control.
PreProcessControlMessage(Message)Preprocesses keyboard or input messages within the message loop before they are dispatched. Inherited from Control.
PreProcessMessage(Message)Preprocesses keyboard or input messages within the message loop before they are dispatched. Inherited from Control.
ProcessCmdKey(Message, Keys) protectedProcesses a command key. Inherited from ContainerControl.
ProcessDialogChar(Char) protectedProcesses a dialog character. Inherited from ContainerControl.
ProcessKeyEventArgs(Message) protectedProcesses a key message and generates the appropriate control events. Inherited from Control.
ProcessKeyMessage(Message) protectedProcesses a keyboard message. Inherited from Control.
ProcessKeyPreview(Message) protectedPreviews a keyboard message. Inherited from Control.
ProcessMnemonic(Char) protectedProcesses a mnemonic character. Inherited from ContainerControl.
ProcessTabKey(Boolean) protectedSelects the next available control and makes it the active control. Inherited from ContainerControl.
RaiseDragEvent(Object, DragEventArgs) protectedRaises the appropriate drag event. Inherited from Control.
RaiseKeyEvent(Object, KeyEventArgs) protectedRaises the appropriate key event. Inherited from Control.
RaiseMouseEvent(Object, MouseEventArgs) protectedRaises the appropriate mouse event. Inherited from Control.
RaisePaintEvent(Object, PaintEventArgs) protectedRaises the appropriate paint event. Inherited from Control.
RecreateHandle() protectedForces the re-creation of the handle for the control. Inherited from Control.
RectangleToClient(Rectangle)Computes the size and location of the specified screen rectangle in client coordinates. Inherited from Control.
RectangleToScreen(Rectangle)Computes the size and location of the specified client rectangle in screen coordinates. Inherited from Control.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
ReflectMessage(IntPtr, Message) protected staticReflects the specified message to the control that is bound to the specified handle. Inherited from Control.
Refresh()Forces the control to invalidate its client area and immediately redraw itself and any child controls. Inherited from Control.
ReloadData()Reloads data in the data sources.
ReloadData(Boolean)Reloads data in the data sources.
ReloadData(String)Reloads data from the data source for the specified dashboard item.
ReloadDataAsync()Reloads data in the data sources asynchronously.
ReloadDataAsync(String)Reloads data from the data source for the specified dashboard item asynchronously.
ReloadDataAsync(CancellationToken)Reloads data in the data sources asynchronously.
ReloadDataSource(IDashboardDataSource)Reloads data from the specified data source instance.
ReloadDataSource(String)Reloads data from the specified data source. Accepts data source component name as the parameter.
ReloadDataSourceAsync(IDashboardDataSource, CancellationToken)Reloads data from the specified data source instance. The operation is asynchronous. You can propagate a notification to cancel it.
ReloadDataSourceAsync(IDashboardDataSource)Reloads data from the specified data source. Accepts data source object as the parameter. The operation is asynchronous.
ReloadDataSourceAsync(String, CancellationToken)Reloads data from the specified data source. Accepts data source component name as the parameter. The operation is asynchronous. You can propagate a notification to cancel it.
ReloadDataSourceAsync(String)Reloads data from the specified data source. Accepts data source component name as the parameter. The operation is asynchronous.
ResetAsyncMode()For internal use.
ResetBackColor()Resets the XtraUserControl.BackColor property back to its default value. Inherited from XtraUserControl.
ResetBindings()Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values. Inherited from Control.
ResetCursor()Resets the Cursor property to its default value. Inherited from Control.
ResetFont()Resets the Font property to its default value. Inherited from Control.
ResetForeColor()Sets the XtraUserControl.ForeColor property to Color.Empty. Inherited from XtraUserControl.
ResetImeMode()Resets the ImeMode property to its default value. Inherited from Control.
ResetMouseEventArgs() protectedResets the control to handle the MouseLeave event. Inherited from Control.
ResetRightToLeft()Resets the RightToLeft property to its default value. Inherited from Control.
ResetText()Resets the Text property to its default value (Empty). Inherited from Control.
ResetUseNeutralFilterMode()For internal use.
RestoreDashboardItem()Restores the item size if an item is expanded to the entire dashboard size (maximized).
RestoreDashboardItemAsync()Restores the item size if an item is expanded to the entire dashboard size (maximized) in an asynchronous task.
ResumeLayout()Resumes usual layout logic. Inherited from Control.
ResumeLayout(Boolean)Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests. Inherited from Control.
RtlTranslateAlignment(ContentAlignment) protectedConverts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. Inherited from Control.
RtlTranslateAlignment(HorizontalAlignment) protectedConverts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. Inherited from Control.
RtlTranslateAlignment(LeftRightAlignment) protectedConverts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. Inherited from Control.
RtlTranslateContent(ContentAlignment) protectedConverts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. Inherited from Control.
RtlTranslateHorizontal(HorizontalAlignment) protectedConverts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. Inherited from Control.
RtlTranslateLeftRight(LeftRightAlignment) protectedConverts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. Inherited from Control.
SaveDashboardLayout(Stream)Saves a dashboard layout (layout items and layout containers) to a stream.
SaveDashboardLayout(String)Saves a dashboard layout to a separate XML file.
Scale(SizeF)Scales the control and all child controls by the specified scaling factor. Inherited from Control.
Scale(Single, Single)Scales the entire control and any child controls. Inherited from Control.
Scale(Single)Scales the control and any child controls. Inherited from Control.
ScaleCore(Single, Single) protectedThis method is not relevant for this class. Inherited from ScrollableControl.
ScrollControlIntoView(Control)Scrolls the specified child control into view on an auto-scroll enabled control. Inherited from ScrollableControl.
ScrollToControl(Control) protectedCalculates the scroll offset to the specified child control. Inherited from ScrollableControl.
Select()Activates the control. Inherited from Control.
Select(Boolean, Boolean) protectedActivates a child control. Optionally specifies the direction in the tab order to select the control from. Inherited from ContainerControl.
SelectNextControl(Control, Boolean, Boolean, Boolean, Boolean)Activates the next control. Inherited from Control.
SendToBack()Sends the control to the back of the z-order. Inherited from Control.
SetAutoScrollMargin(Int32, Int32)Sets the size of the auto-scroll margins. Inherited from ScrollableControl.
SetAutoSizeMode(AutoSizeMode) protectedSets a value indicating how a control will behave when its AutoSize property is enabled. Inherited from Control.
SetBounds(Int32, Int32, Int32, Int32, BoundsSpecified)Sets the specified bounds of the control to the specified location and size. Inherited from Control.
SetBounds(Int32, Int32, Int32, Int32)Sets the bounds of the control to the specified location and size. Inherited from Control.
SetClientSizeCore(Int32, Int32) protectedSets the size of the client area of the control. Inherited from Control.
SetDashboardState(DashboardState)Applies the dashboard state to the loaded dashboard.
SetDashboardStateAsync(DashboardState, CancellationToken)Applies the dashboard state to the dashboard, asynchronously.
SetDashboardStateAsync(DashboardState)Applies the dashboard state to the dashboard, asynchronously.
SetDisplayRectLocation(Int32, Int32) protectedPositions the display window to the specified value. Inherited from ScrollableControl.
SetMasterFilter(String, AxisPointTuple)Selects required elements in the specified master filter item.
SetMasterFilter(String, IEnumerable<DashboardDataRow>)Selects required elements in the specified master filter item.
SetMasterFilter(String, IEnumerable<AxisPointTuple>)Selects the required elements in the specified master filter item.
SetMasterFilter(String, Object)Selects required elements by their values in the specified master filter item.
SetMasterFilterAsync(String, AxisPointTuple, CancellationToken)Selects the specified elements in the specified master filter item.
SetMasterFilterAsync(String, AxisPointTuple)Selects the specified elements in the specified master filter item.
SetMasterFilterAsync(String, IEnumerable<DashboardDataRow>, CancellationToken)Selects the specified elements in the specified master filter item.
SetMasterFilterAsync(String, IEnumerable<DashboardDataRow>)Selects the elements by their values in the specified master filter item.
SetMasterFilterAsync(String, IEnumerable<AxisPointTuple>, CancellationToken)Selects the specified elements in the specified master filter item.
SetMasterFilterAsync(String, IEnumerable<AxisPointTuple>)Selects the elements by their values in the specified master filter item.
SetMasterFilterAsync(String, Object, CancellationToken)Selects the specified elements in the specified master filter item.
SetMasterFilterAsync(String, Object)Selects the specified elements in the specified master filter item.
SetRange(String, RangeFilterSelection)Selects the required range in the specified Range Filter or Date Filter dashboard item.
SetRange(String, String)Selects the specified range in the specified dashboard item that is the Range Filter or Date Filter.
SetRangeAsync(String, RangeFilterSelection, CancellationToken)Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously.
SetRangeAsync(String, RangeFilterSelection)Selects the required range in the specified Range Filter or Date Filter dashboard item asynchronously.
SetRangeAsync(String, String, CancellationToken)Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously.
SetRangeAsync(String, String)Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously.
SetScrollState(Int32, Boolean) protectedSets the specified scroll state flag. Inherited from ScrollableControl.
SetSelectedTabPage(String, Int32)Selects the tab page specified by its index in the specified tab container.
SetSelectedTabPage(String)Selects the specified tab page.
SetStyle(ControlStyles, Boolean) protectedSets a specified ControlStyles flag to either true or false. Inherited from Control.
SetTopLevel(Boolean) protectedSets the control as the top-level control. Inherited from Control.
ShouldSerializeAsyncMode()For internal use.
ShouldSerializeUseNeutralFilterMode()For internal use.
Show()Displays the control to the user. Inherited from Control.
ShowDashboardParametersForm()Invokes the Dashboard Parameters dialog in the DashboardDesigner.
ShowDataInspector(String, InspectedType)Invokes the Data Inspector dialog with a defined data type for the specified dashboard item.
ShowDataInspector(String)Invokes the Data Inspector dialog for the specified dashboard item.
ShowDataInspectorAsync(String, InspectedType)Invokes the Data Inspector dialog with a defined data type for the specified dashboard item.
ShowDataInspectorAsync(String)Invokes the Data Inspector dialog with a defined data type for the specified dashboard item.
ShowDataSourceWizard()Invokes the Data Source wizard.
ShowExportDashboardDialog(DashboardExportFormat)Invokes the dialog that allows end-users to export the entire dashboard to the specified format.
ShowExportDashboardItemDialog(String, DashboardExportFormat)Invokes the dialog that allows end-users to export the dashboard item to the specified format.
ShowPrintPreview()Invokes the Print Preview, which shows the print preview of the dashboard.
ShowPrintPreview(String)Invokes the Print Preview window for the specified dashboard item.
ShowRibbonPrintPreview()Invokes the Ribbon Print Preview Form, which shows the print preview of the dashboard.
ShowRibbonPrintPreview(String)Invokes the Ribbon Print Preview window for the specified dashboard item.
SizeFromClientSize(Size) protectedDetermines the size of the entire control from the height and width of its client area. Inherited from Control.
SuspendLayout()Temporarily suspends the layout logic for the control. Inherited from Control.
IContainerControl.ActivateControl(Control)Activates the specified control. Inherited from ContainerControl.
IDropTarget.OnDragDrop(DragEventArgs)Raises the DragDrop event. Inherited from Control.
IDropTarget.OnDragEnter(DragEventArgs)Raises the DragEnter event. Inherited from Control.
IDropTarget.OnDragLeave(EventArgs)Raises the DragLeave event. Inherited from Control.
IDropTarget.OnDragOver(DragEventArgs)Raises the DragOver event. Inherited from Control.
ToString()Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.
Update()Causes the control to redraw the invalidated regions within its client area. Inherited from Control.
UpdateBounds() protectedUpdates the bounds of the control with the current size and location. Inherited from Control.
UpdateBounds(Int32, Int32, Int32, Int32, Int32, Int32) protectedUpdates the bounds of the control with the specified size, location, and client size. Inherited from Control.
UpdateBounds(Int32, Int32, Int32, Int32) protectedUpdates the bounds of the control with the specified size and location. Inherited from Control.
UpdateDashboardItemCaption(String)Fires the CustomizeDashboardItemCaption event for the specified dashboard item.
UpdateDashboardTitle()Fires the CustomizeDashboardTitle event that allows you to customize the dashboard title content.
UpdateDefaultButton() protectedWhen overridden by a derived class, updates which button is the default button. Inherited from ContainerControl.
UpdateExtractDataSourcesAsync(Action<String, ExtractUpdateResult>, Action<String, ExtractUpdateResult>, String[])Updates the specified extract data sources in the current dashboard asynchronously. Allows you to set custom actions to perform after updating the data and file.
UpdateExtractDataSourcesAsync(Action<String, ExtractUpdateResult>, Action<String, ExtractUpdateResult>)Updates all extract data sources in the current dashboard asynchronously. Allows you to set custom actions to perform after updating the data and file.
UpdateExtractFile(Boolean, String)Updates a file containing a data extract.
UpdateStyles() protectedForces the assigned styles to be reapplied to the control. Inherited from Control.
UpdateZOrder() protectedUpdates the control in its parent’s z-order. Inherited from Control.
Validate()Verifies the value of the control losing focus by causing the Validating and Validated events to occur, in that order. Inherited from ContainerControl.
Validate(Boolean)Verifies the value of the control that is losing focus; conditionally dependent on whether automatic validation is turned on. Inherited from ContainerControl.
ValidateChildren()Causes all of the child controls within a control that support validation to validate their data. Inherited from UserControl.
ValidateChildren(ValidationConstraints)Causes all of the child controls within a control that support validation to validate their data. Inherited from UserControl.

Events

NameDescription
AsyncDataLoadingAllows you to provide data for the DashboardObjectDataSource in asynchronous mode.
AsyncExcelDataSourceBeforeFillAllows you to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files asynchronously.
AsyncValidateCustomSqlQueryAllows you to validate a custom SQL query of the DashboardSqlDataSource in asynchronous mode.
AutoSizeChangedOccurs when the AutoSize property changes. Inherited from UserControl.
AutoValidateChangedOccurs when the AutoValidate property changes. Inherited from UserControl.
BackColorChangedOccurs when the value of the BackColor property changes. Inherited from Control.
BackgroundImageChangedOccurs when the value of the BackgroundImage property changes. Inherited from Control.
BackgroundImageLayoutChangedOccurs when the BackgroundImageLayout property changes. Inherited from Control.
BeforeExportDocumentAllows you to hide specific dashboard items when printing or exporting the entire dashboard.
BindingContextChangedOccurs when the value of the BindingContext property changes. Inherited from Control.
CausesValidationChangedOccurs when the value of the CausesValidation property changes. Inherited from Control.
ChangeUICuesOccurs when the focus or keyboard user interface (UI) cues change. Inherited from Control.
ClickOccurs when the control is clicked. Inherited from Control.
ClientSizeChangedOccurs when the value of the ClientSize property changes. Inherited from Control.
ConfigureDataConnectionAllows you to customize connection settings before the DashboardDesigner connects to a data store (database, OLAP cube, etc.).
ConnectionErrorAllows users to override the default behavior if data store connection fails with current connection parameters.
ContextMenuChangedOccurs when the value of the ContextMenu property changes. Inherited from Control.
ContextMenuStripChangedOccurs when the value of the ContextMenuStrip property changes. Inherited from Control.
ControlAddedOccurs when a new control is added to the Control.ControlCollection. Inherited from Control.
ControlRemovedOccurs when a control is removed from the Control.ControlCollection. Inherited from Control.
CursorChangedOccurs when the value of the Cursor property changes. Inherited from Control.
CustomAssemblyLoadingOccurs before a custom assembly is loaded for use as DashboardEFDataSource.
CustomDashboardItemControlCreatingOccurs when a dashboard control visualizes a custom item.
CustomExportAllows you to customize the exported document.
CustomFilterExpressionAllows you to include WHERE clauses into DashboardSqlDataSource queries.
CustomizeDashboardItemCaptionAllows you to customize the dashboard item caption at runtime.
CustomizeDashboardTitleAllows you to customize the dashboard title at runtime.
CustomizeExportDocumentAllows you to customize the exported document.
CustomPaletteProvides the capability to substitute the default palette containing colors used to paint dashboard item elements.
CustomParametersOccurs before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing.
DashboardChangedOccurs after a dashboard has been opened.
DashboardClosingOccurs after the current dashboard opened in the DashboardDesigner is being closed.
DashboardCreatingAllows you to customize a dashboard when it is being created.
DashboardCustomPropertyChangedOccurs when the custom property value in the Dashboard Designer is changed.
DashboardItemBeforeControlDisposedAllows you to access underlying WinForms controls.
DashboardItemClickOccurs when an end-user clicks a dashboard item.
DashboardItemControlCreatedAllows you to access underlying WinForms controls.
DashboardItemControlUpdatedAllows you to access underlying WinForms controls.
DashboardItemDoubleClickOccurs when an end-user double-clicks a dashboard item.
DashboardItemElementCustomColorAllows you to color the required dashboard item elements using the specified colors.
DashboardItemMaximizedStateChangedFires when an item becomes maximized or restores its original size.
DashboardItemMouseDownOccurs when the mouse pointer is over the dashboard item and a mouse button is pressed.
DashboardItemMouseEnterOccurs when the mouse pointer enters the dashboard item.
DashboardItemMouseHoverOccurs when the mouse pointer rests on the dashboard item.
DashboardItemMouseLeaveOccurs when the mouse pointer leaves the dashboard item.
DashboardItemMouseMoveOccurs when the mouse pointer is moved over the dashboard item.
DashboardItemMouseUpOccurs when the mouse pointer is over the dashboard item and a mouse button is released.
DashboardItemMouseWheelOccurs when the mouse wheel moves while the dashboard item has focus.
DashboardItemSelectedOccurs after you select a dashboard item.
DashboardItemSelectionChangedOccurs after the selection within the dashboard item is changed.
DashboardItemVisualInteractivityAllows you to provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting.
DashboardLoadedOccurs after the dashboard is loaded to the DashboardDesigner.
DashboardOpeningAllows you to implement custom logic for dashboard opening.
DashboardOptionsChangedOccurs after any option in the Dashboard is changed.
DashboardSavedAllows you to obtain the path to the dashboard XML definition before and after the save operation.
DashboardSavingAllows you to implement custom logic for dashboard saving.
DashboardStateChangedOccurs after the current dashboard state in the DashboardDesigner is changed.
DataInspectorFormClosingOccurs before the Data Inspector window closes. Allows you to access the window’s grid controls.
DataInspectorFormLoadOccurs before the Data Inspector window displays. Allows you to access the window’s grid controls and change their settings.
DataItemPopupMenuShowingAllows you to customize a data item popup menu invoked in the UI.
DataLoadingAllows you to provide data for the DashboardObjectDataSource.
DataLoadingErrorAllows you to suppress the form containing errors that occur during data loading.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DockChangedOccurs when the value of the Dock property changes. Inherited from Control.
DoubleClickOccurs when the control is double-clicked. Inherited from Control.
DragDropOccurs when a drag-and-drop operation is completed. Inherited from Control.
DragEnterOccurs when an object is dragged into the control’s bounds. Inherited from Control.
DragLeaveOccurs when an object is dragged out of the control’s bounds. Inherited from Control.
DragOverOccurs when an object is dragged over the control’s bounds. Inherited from Control.
DrillDownPerformedOccurs after a drill-down is performed.
DrillUpPerformedOccurs after a drill-up is performed.
EnabledChangedOccurs when the Enabled property value has changed. Inherited from Control.
EnterOccurs when the control is entered. Inherited from Control.
ExportFormShowingOccurs when the Export Form is about to be displayed, and allows you to cancel the action.
FontChangedOccurs when the Font property value changes. Inherited from Control.
ForeColorChangedOccurs when the ForeColor property value changes. Inherited from Control.
GiveFeedbackOccurs during a drag operation. Inherited from Control.
GotFocusOccurs when the control receives focus. Inherited from Control.
HandleCreatedOccurs when a handle is created for the control. Inherited from Control.
HandleDestroyedOccurs when the control’s handle is in the process of being destroyed. Inherited from Control.
HelpRequestedOccurs when the user requests help for a control. Inherited from Control.
ImeModeChangedOccurs when the ImeMode property has changed. Inherited from Control.
InitializedHandle this event to get the dashboard item data, and apply the master filter and dashboard state in asynchronous mode.
InvalidatedOccurs when a control’s display requires redrawing. Inherited from Control.
KeyDownOccurs when a key is pressed while the control has focus. Inherited from Control.
KeyPressOccurs when a character. space or backspace key is pressed while the control has focus. Inherited from Control.
KeyUpOccurs when a key is released while the control has focus. Inherited from Control.
LayoutOccurs when a control should reposition its child controls. Inherited from Control.
LayoutChangedOccurs after the dashboard layout is changed.
LeaveOccurs when the input focus leaves the control. Inherited from Control.
LoadOccurs before the control becomes visible for the first time. Inherited from UserControl.
LocationChangedOccurs when the Location property value has changed. Inherited from Control.
LostFocusOccurs when the control loses focus. Inherited from Control.
MarginChangedOccurs when the control’s margin changes. Inherited from Control.
MasterFilterClearedOccurs when an end-user clears the selection in the master filter item.
MasterFilterDefaultValuesAllows you to apply default filtering to master filter items.
MasterFilterSetOccurs when an end-user changes the state of the master filter.
MouseCaptureChangedOccurs when the control loses mouse capture. Inherited from Control.
MouseClickOccurs when the control is clicked by the mouse. Inherited from Control.
MouseDoubleClickOccurs when the control is double clicked by the mouse. Inherited from Control.
MouseDownOccurs when the mouse pointer is over the control and a mouse button is pressed. Inherited from Control.
MouseEnterOccurs when the mouse pointer enters the control. Inherited from Control.
MouseHoverOccurs when the mouse pointer rests on the control. Inherited from Control.
MouseLeaveOccurs when the mouse pointer leaves the control. Inherited from Control.
MouseMoveOccurs when the mouse pointer is moved over the control. Inherited from Control.
MouseUpOccurs when the mouse pointer is over the control and a mouse button is released. Inherited from Control.
MouseWheelOccurs when the mouse wheel moves while the control has focus. Inherited from Control.
MoveOccurs when the control is moved. Inherited from Control.
PaddingChangedOccurs when the control’s padding changes. Inherited from Control.
PaintOccurs when the control is redrawn. Inherited from Control.
PaintExA DirectX-compatible event that replaces the standard Control.Paint event. Occurs when the control is redrawn. Inherited from XtraUserControl.
ParentChangedOccurs when the Parent property value changes. Inherited from Control.
PopupMenuShowingAllows you to customize the pop-up menu that users invoke in the DashboardDesigner.
PreviewKeyDownOccurs before the KeyDown event when a key is pressed while focus is on this control. Inherited from Control.
PrintPreviewShowingAllows you to customize the Print Preview window at runtime.
QueryAccessibilityHelpOccurs when AccessibleObject is providing help to accessibility applications. Inherited from Control.
QueryContinueDragOccurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled. Inherited from Control.
RangeFilterDefaultValueProvides the capability to specify the default selected range in the Range Filter dashboard item.
RangeFilterPredefinedDateTimePeriodsAllows you to customize the list of predefined periods in the Edit Periods dialog for the Range Filter dashboard item.
RegionChangedOccurs when the value of the Region property changes. Inherited from Control.
ResizeOccurs when the control is resized. Inherited from Control.
RightToLeftChangedOccurs when the RightToLeft property value changes. Inherited from Control.
ScrollOccurs when the user or code scrolls through the client area. Inherited from ScrollableControl.
SelectedDataSourceChangedOccurs after the selected data source or query/data member is changed in the Data Source Browser.
SelectedTabPageChangedOccurs when the selected tab page is changed.
SetInitialDashboardStateAllows you to specify the initial dashboard state when loading a dashboard.
SizeChangedOccurs when the Size property value changes. Inherited from Control.
StyleChangedOccurs when the control style changes. Inherited from Control.
SystemColorsChangedOccurs when the system colors change. Inherited from Control.
TabIndexChangedOccurs when the TabIndex property value changes. Inherited from Control.
TabStopChangedOccurs when the TabStop property value changes. Inherited from Control.
TextChangedRaises the TextChanged event. Inherited from UserControl.
ValidateCustomSqlQueryAllows you to validate a custom SQL query of the DashboardSqlDataSource.
ValidatedOccurs when the control is finished validating. Inherited from Control.
ValidatingOccurs when the control is validating. Inherited from Control.
VisibleChangedOccurs when the Visible property value changes. Inherited from Control.

See Also

DashboardDesigner Class

DevExpress.DashboardWin Namespace