DevExpress.Dashboard.v20.1.Win

Contains classes that provide functionality to the Data Source wizard page presenters.

Provides a presenter to the Select Data Fields page of the Data Source wizard (Extract Data Source).

Initializes a new instance of the class with the specified settings.

An object implementing the interface that provides a view for a wizard page. An object implementing the interface providing information about a data source used to create a data extract. An object implementing the interface that provides the functionality to run the wizard.

Initializes controls of the current wizard page.

Saves settings specified by a wizard page.

Specifies whether the Finish button is enabled on a wizard page.

true, if the Finish button is enabled; otherwise, false.

Returns the type of the next wizard page.

A enumeration value.

Specifies whether the Next button is enabled on a wizard page.

true, if the Next button is enabled; otherwise, false.

Provides a presenter to the Select a Data Connection page of the Data Source wizard (OLAP Data Source).

Initializes a new instance of the class with the specified settings.

An object implementing the interface that provides a view for a wizard page. An object implementing the interface used to get information about data connections. An object implementing the interface that provides the functionality to run the wizard.

Initializes controls of the current wizard page.

Saves settings specified by a wizard page.

Specifies whether the Finish button is enabled on a wizard page.

true, if the Finish button is enabled; otherwise, false.

Returns the type of the next wizard page.

A enumeration value.

Specifies whether the Next button is enabled on a wizard page.

true, if the Next button is enabled; otherwise, false.

Validates the correctness of settings specified on the current wizard page.

A value specifying the text of an error message shown if the validation fails. true, if the validation succeeded; otherwise, false.

Provides a presenter to the Specify Filter Options page of the Data Source wizard (Extract Data Source).

Initializes a new instance of the class with the specified settings.

Initializes controls of the current wizard page.

Saves settings specified by a wizard page.

Specifies whether the Finish button is enabled on a wizard page.

true, if the Finish button is enabled; otherwise, false.

Returns the type of the next wizard page.

A enumeration value.

Specifies whether the Next button is enabled on a wizard page.

true, if the Next button is enabled; otherwise, false.

Validates the correctness of settings specified on the current wizard page.

A value specifying the text of an error message shown if the validation fails. true, if the validation succeeded; otherwise, false.

Provides a presenter to the Configure Connection Parameters page of the Data Source wizard (OLAP Data Source).

Initializes a new instance of the class with the specified settings.

Initializes controls of the current wizard page.

Saves settings specified by a wizard page.

Specifies whether the Finish button is enabled on a wizard page.

true, if the Finish button is enabled; otherwise, false.

Returns the type of the next wizard page.

A enumeration value.

Specifies whether the Next button is enabled on a wizard page.

true, if the Next button is enabled; otherwise, false.

Validates the correctness of settings specified on the current wizard page.

A value specifying the text of an error message shown if the validation fails. true, if the validation succeeded; otherwise, false.

Provides a presenter to the Create a Data Extract page of the Data Source wizard (Extract Data Source).

Initializes a new instance of the class with the specified settings.

Initializes controls of the current wizard page.

Saves settings specified by a wizard page.

Specifies whether the Finish button is enabled on a wizard page.

true, if the Finish button is enabled; otherwise, false.

Returns the type of the next wizard page.

A enumeration value.

Specifies whether the Next button is enabled on a wizard page.

true, if the Next button is enabled; otherwise, false.

Validates the correctness of settings specified on the current wizard page.

A value specifying the text of an error message shown if the validation fails. true, if the validation succeeded; otherwise, false.

Provides a presenter to the Enter the Data Source Name page of the Data Source wizard.

Initializes a new instance of the class.

A page view.

Saves settings specified by a wizard page.

Returns the type of the next wizard page.

A enumeration value.

Provides a presenter to the Select the Data Source Type page of the Data Source wizard.

Initializes a new instance of the class.

Returns the type of the next wizard page.

A enumeration value.

Provides a presenter to the Specify Extract Parameters page of the Data Source wizard (Extract Data Source).

Initializes a new instance of the class with the specified settings.

An object implementing the interface. An object implementing the interface. An object implementing the interface. An object implementing the interface.

Initializes controls of the current wizard page.

Saves settings specified by a wizard page.

Specifies whether the Finish button is enabled on a wizard page.

true, if the Finish button is enabled; otherwise, false.

Returns the type of the next wizard page.

A enumeration value.

Specifies whether the Next button is enabled on a wizard page.

true, if the Next button is enabled; otherwise, false.

If implemented, provides a view for the Select Data Fields page of the Data Source Wizard (Extract Data Source).

Gets a list containing fields that will fall into a data extract.

An object implementing the IDataFieldsBrowserView interface.

If implemented, provides a view for the Specify Filter Options page of the Data Source Wizard (Extract Data Source).

Occurs when any option is changed in the wizard page.

Gets or sets filter criteria applied to extract data.

A that specifies filter criteria applied to extract data.

Gets or sets the number of rows that will fall into a data extract.

An integer value that specifies the number of rows that will fall into a data extract.

Occurs when a preview window is invoked.

Specifies columns that will fall into filter criteria applied to extract data.

An object implementing the object. A value that is a data member from the data source. An object implementing the interface.

Invokes a preview window.

An object that contains data to be shown in a preview window.

If implemented, provides a view for the Configure Connection Parameters page of the Data Source Wizard (OLAP Data Source).

Gets an OLAP connection by the specified connection parameters.

An object that is an OLAP connection.

If implemented, provides a view for the Create a Data Extract page of the Data Source Wizard (Extract Data Source).

Occurs when any option is changed in the wizard page.

Gets or sets a data member specified in the wizard page.

A that is a data member specified in the wizard page.

Gets or sets whether on not an option allowing end-users to select a data member is enabled.

true, to enable an option allowing end-users to select a data member; otherwise, false.

Gets or sets data members available in the wizard page.

A collection of the values that are data members available in the wizard page.

Gets or sets data source names available in the wizard page.

A collection of the values that are data source names available in the wizard page.

Gets or sets a mode for creating a data extract.

An ExtractCreationMode object that specifies a mode for creating a data extract.

Gets or sets a name of the driver used to read/write a data extract.

A value that specifies a name of the driver used to read/write a data extract.

Gets or sets a path to the file containing a data extract.

A value that specifies a path to the file containing a data extract.

Occurs when a selected data member is changed in the wizard page.

Occurs when a selected data source is changed in the wizard page.

Gets or sets an index of the selected data source.

An integer value that specifies an index of the selected data source.

If implemented, provides a view for the Specify Extract Parameters page of the Data Source Wizard (Extract Data Source).

Initializes a parameter's editor on the wizard page.

A collection of objects implementing the interface. A collection of DashboardParameterViewModel objects.

Occurs when a preview window is invoked.

Gets parameters displayed in the wizard page.

A collection of objects implementing the interface.

Invokes a preview window.

An object that contains data to be shown in a preview window.

If implemented, provides a view for the Save Extract to a File page of the Data Source Wizard (Extract Data Source).

Gets or sets a path to a data extract file.

A value that specifies a path to a data extract file.

Occurs when a path to a data extract file is changed.

Returns an object that displays a form while the wizard is loading information about a data extract.

An object implementing the IDashboardWaitFormActivator interface.

Provides a presenter to the Save Extract to a File page of the Data Source wizard (Extract Data Source).

Initializes a new instance of the class with the specified settings.

An object implementing the interface. An object implementing the interface.

Initializes controls of the current wizard page.

Saves settings specified by a wizard page.

Specifies whether the Finish button is enabled on a wizard page.

true, if the Finish button is enabled; otherwise, false.

Specifies whether the Next button is enabled on a wizard page.

true, if the Next button is enabled; otherwise, false.

Contains classes that implement the and controls for Windows Forms.

A Card control that is used to visualize a Card dashboard item's data.

Initializes a new instance of the class.

Gets or sets the background color for a card.

A value specifying the background color for a card.

Allows you to customize the texts corresponding to card visual elements.

Provides data for the event.

Gets or sets the text displayed within a card visual element.

A value that specifies the text displayed within a card visual element.

Gets the value(s) corresponding to a card visual element.

An object that is the value(s) corresponding to a card visual element.

References a method that handles the event.

The event source. A object that contains event data.

Contains settings that specify parameters affecting how the Card dashboard item is printed or exported.

Initialize a new instance of the class with default settings.

Gets or sets whether dashboard item elements are arranged automatically on the printed page.

true, to arrange dashboard item elements automatically on the printed page; otherwise, false.

Contains settings that specify parameters affecting how the Chart dashboard item is printed or exported.

Initialize a new instance of the class with default settings.

Gets or sets whether the page orientation used to print a chart dashboard item is selected automatically.

true, to automatically select the page orientation used to print a chart dashboard item; otherwise, false.

Gets or sets the print size mode for the chart dashboard item.

A enumeration member that specifies the print size mode for the chart dashboard item.

Lists values used to specify how a Chart dashboard item should be resized when being printed or exported.

A chart dashboard item is printed in a size identical to that shown on the dashboard.

A chart dashboard item is stretched or shrunk to fit the page on which it is printed.

A chart dashboard item is resized proportionally to best fit the printed page.

Base class for EventArgs passed to the CustomizeDashboardTitle and CustomizeDashboardItemCaption events of DashboardDesigner and DashboardViewer controls.

Gets or sets the text displayed in the dashboard title or in the dashboard item caption. The text identifies a single master filter value applied to the dashboard.

Provides access to command buttons located in the dashboard title or in the dashboard item's caption.

A collection of objects which are command buttons in the title or caption area.

Gets or sets the text displayed in the dashboard title or the dashboard item caption.

A string that is the text displayed in the dashboard title or in the dashboard item caption.

Provides data for the and events.

Initializes a new instance of the class.

A that is the dashboard item component name. A text to display in the dashboard caption. A text to display as the master filter state. True to display an item caption; otherwise, false.

Gets the name of the current dashboard item.

A string that is the dashboard item's name.

Gets or sets whether the current dashboard item's caption is shown,

True, to display an item's caption; otherwise, false.

A method that handles the and

The event source. A object that contains event data.

Provides data for the and events.

Initializes a new instance of the class.

A text to display as the dashboard title text. A text to display as the master filter state.

A method that handles the and events.

The event source. A object that contains event data.

Provides data for the and events.

Gets or sets the text displayed within the dashboard title.

A that specifies the text displayed within the dashboard title.

References a method that handles the event.

The event source. A object that contains event data.

A basic implementation for a history item.

Initializes a new instance of the class with specified settings.

A provider for the instance. A custom property name. A value that is recorded in the history. A caption that is displayed in the history.

Gets a caption that displays in the history for the current operation.

A object that is a history item caption.

Reapplies the last operation that was undone in the Dashboard Designer.

A instance where the operation is performed.

Undoes the last operation in the Dashboard Designer.

A instance where the operation is performed.

Lists values used to specify the required action when the currently opened dashboard is being closed.

Discards all changes made to the dashboard.

Invokes a save confirmation dialog.

Saves the changes made to the current dashboard.

Lists values that identify the dashboard area.

Identifies a dashboard item.

Identifies a dashboard item caption.

Identifies a dashboard title.

Identifies a page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Bound Image Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Bubble Map Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Cards Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Chart Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Choropleth Map Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Date Filter Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Filter Element Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Gauges Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Geo Point Map Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Grid Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Group Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Image Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies one of the main pages / toolbars.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Pie Map Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Pies Map Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Pivot Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Range Filter Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Scatter Chart Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Tab Container Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Tab Page Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Text Box Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Identifies the "Treemap Tools" page category / toolbar.

A page category in the Ribbon UI or a contextual toolbar in Bar UI.

Provides data for the BeforeExport events.

Initializes a new instance of the class.

Gets or sets whether to show the export form allowing end-users to specify various export options related to the selected format.

true, to show the export form; otherwise, false.

References a method that handles the BeforeExport event.

The event source. A object that contains event data.

Lists values that identify types of dashboard command buttons.

Identifies the Clear Master Filter button.

Identifies the Clear Selection button.

Identifies a button created in the CustomizeDashboardTitle or CustomizeDashboardItemCaption event handlers.

Identifies the Select Date Time Period button of the Range Filter dashboard item.

Identifies the Drill Up button.

Identifies the Export to button.

Identifies the Inspect Data button.

Identifies the Initial Extent button.

Identifies the Maximize button.

Identifies the Multi-Select button.

The value does not correspond to any command button.

Identifies the Parameters button.

Identifies the Restore button.

Identifies the Values button.

Provides data for the event.

Initializes a new instance of the class.

A object that contains the full description of a dashboard. A values that specifies whether the dashboard has been modified since the last save.

Gets the dashboard which is being closed.

A object that represents the dashboard which is being closed.

Gets or sets whether the dashboard has been modified since the last save.

true, if the dashboard has been modified since last save; otherwise, false.

References a method that handles the event.

The event source. A object that contains event data.

Provides data for the event.

Initializes a new instance of the class.

A object.

Gets the created dashboard.

A object that is the newly created dashboard.

Gets or sets whether the dashboard has been initialized.

true, if the dashboard has been initialized and no default processing is needed; otherwise, false.

References a method that handles the event.

The event source. A object that contains event data.

For internal use. Provides access to the Data Source wizard settings. Use the class instance instead.

Gets or sets data source types available in the Data Source wizard.

A enumeration value that specifies data source types available in the Data Source wizard.

Gets or sets SQL data providers available in the Data Source wizard.

A enumeration value that specifies data providers available in the Data Source wizard.

Determines whether the specified object is equal to the current instance.

The object to compare with the current object. true, if the specified object is equal to the current instance; otherwise, false.

Gets the hash code that corresponds to the value of the current object.

An integer value representing the hash code for the current object.

Resets settings exposed by the class to default values.

Gets or sets whether end-users can select connections from the application configuration file.

true, to allow end-users to select connections from the application configuration file; otherwise, the application configuration file..

Gets or sets whether to show the Data Source wizard page allowing end-users to specify the data source name.

true, to show the Data Source wizard page allowing end-users to specify the data source name; otherwise, false.

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

Initializes a new instance of the class with default settings.

Activates the control's About dialog box.

Gets or sets the required action when the currently opened dashboard is being closed.

A enumeration value that specifies the required action.

Allows you to write an action to history.

Gets or sets whether the allows end-users to edit component names.

true, to allow end-users to edit component names; otherwise, false.

Gets or sets whether to display aggregated data in the Data Inspector.

true, to display aggregated data in the Data Inspector; otherwise, false.

Gets or sets whether to display raw data in the Data Inspector.

true, to display raw data in the Data Inspector; otherwise, false.

Gets or sets whether to enable the animation when you maximize or restore dashboard items.

True, to enable the animation; otherwise, false.

Gets or sets whether end users can maximize dashboard items.

true, to allow maximizing dashboard items; otherwise, false.

Gets or sets whether end-users can print or export a dashboard.

true, if end-users can print/export a dashboard; otherwise, false.

Gets or sets whether end-users can print or export dashboard items.

true, if end-users can print/export dashboard items; otherwise, false.

Allows you to provide data for the in asynchronous mode.

Allows you to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files asynchronously.

Switches to asynchronous mode.

True, to use asynchronous mode; otherwise, false.

Allows you to validate a custom SQL query of the in asynchronous mode.

Gets or sets the BarAndDockingController that will provide default appearance options for the 's elements.

A DashboardBarAndDockingController object providing appearance options.

Occurs when an end-user tries to export a dashboard (dashboard item) in the required format.

Allows you to hide specific dashboard items when printing or exporting the entire dashboard.

For internal use.

Locks the object until the method call.

Gets or sets whether to calculate totals for the hidden data items.

true, to calculate hidden totals; otherwise, false.

Returns whether the specified master filter can be cleared in the current state.

A that is the component name of the dashboard item. true, if the specified master filter can be cleared in the current state; otherwise, false.

Returns whether drill down is possible in the current state of the specified dashboard item.

A that is the component name of the dashboard item. true, if drill down is possible in the current state of the specified dashboard item; otherwise, false.

Returns whether drill up is possible in the current state of the specified dashboard item.

A that specifies the component name of the dashboard item. true, if drill up is possible in the current state of the specified dashboard item; otherwise, false.

Returns whether the master filter item allows selecting one or more elements.

A that is the component name of the dashboard item. true, if the master filter item allows selecting one or more elements; otherwise, false.

Returns whether the master filter item allows selecting multiple elements.

A that is the component name of the dashboard item. true, if the master filter item allows selecting multiple elements; otherwise, false.

Clears the specified master filter item.

A that specifies the component name of the dashboard item.

Clears the specified master filter item in asynchronous mode.

A that specifies the component name of the dashboard item. The task object that is the asynchronous operation to complete.

Clears the specified master filter item in asynchronous mode.

A that specifies the component name of the dashboard item. Propagates notification that operations should be canceled. The task object that is the asynchronous operation to complete.

Obsolete. Use the method instead.

Allows you to customize connection settings before the connects to a data store (database, OLAP cube, etc.).

Gets or sets whether to show the save confirmation dialog when a window that contains the is closed.

true to show the save confirmation dialog when a window that contains the is closed; otherwise, false.

Allows overriding the default behavior when current connection parameters do not allow connecting to a data store.

Creates and initializes a toolbar menu in the 's parent control.

Creates and initializes a Ribbon in the 's parent control.

Occurs before a custom assembly is loaded for use as .

Gets the list of custom data connections displayed in the Create Data Source wizard.

A object containing custom data connections displayed in the Create Data Source wizard.

Allows you to specify a custom schema for the SQL Data Source.

An object that implements the interface that provides a custom schema.

Allows you to customize the exported document.

Allows you to include WHERE clauses into queries.

Allows you to customize the dashboard item caption at runtime.

Allows you to customize the dashboard title at runtime.

Allows you to customize the text displayed within the dashboard title at runtime.

Allows you to customize the exported document.

Provides the capability to substitute the default palette containing colors used to paint dashboard item elements.

Occurs before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing.

Gets or sets the currently opened dashboard.

A object that is the currently opened dashboard.

Occurs after a dashboard has been opened.

Occurs after the current dashboard opened in the is being closed.

Allows you to customize a dashboard when it is being created.

Occurs when the custom property value in the Dashboard Designer is changed.

Gets the name of the file where the currently opened dashboard is stored.

A that specifies the name of the file where the currently open dashboard is stored.

Allows you to access underlying WinForms controls.

Occurs when an end-user clicks a dashboard item.

Allows you to access underlying WinForms controls.

Occurs when an end-user double-clicks a dashboard item.

Allows you to color the required dashboard item elements using the specified colors.

Fires when an item becomes maximized or restores its original size.

Occurs when the mouse pointer is over the dashboard item and a mouse button is pressed.

Occurs when the mouse pointer enters the dashboard item.

Occurs when the mouse pointer rests on the dashboard item.

Occurs when the mouse pointer leaves the dashboard item.

Occurs when the mouse pointer is moved over the dashboard item.

Occurs when the mouse pointer is over the dashboard item and a mouse button is released.

Occurs when the mouse wheel moves while the dashboard item has focus.

Occurs after you select a dashboard item.

Occurs after the selection within the dashboard item is changed.

Allows you to provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting.

Occurs after the dashboard is loaded to the .

Allows you to implement custom logic for dashboard opening.

Occurs after any option in the is changed.

Allows to obtain the path to the dashboard XML definition before and after the save operation.

Allows you to implement custom logic for dashboard saving.

Occurs after the current dashboard state in the is changed.

Occurs before the Data Inspector window closes. Allows you to access the window's grid controls.

Occurs before the Data Inspector window displays. Allows you to access the window's grid controls and change their settings.

Allows you to provide data for the .

Allows you to suppress the form containing errors that occur during data loading.

Provides access to options that define the data source options of a .

A object containing options that define the data source options of a .

Allows you to customize the Data Source wizard used to create new data sources in the .

A object that provides access to the Data Source wizard settings.

Provides the capability to customize the Data Source wizard used to create new data sources.

An object implementing the IDashboardDataSourceWizardCustomization interface.

Provides the capability to customize the Data Source wizard used to create new data sources.

An object implementing the interface.

This property is for internal use. Use the equivalent property instead.

A object containing settings used to customize the Data Source wizard used to create new data sources in the .

Occurs after a drill-down is performed.

Occurs after a drill-up is performed.

Gets or sets whether the displays a Wait Form when a time-consuming operation is performed.

true, if the displays a Wait Form when a time-consuming operation is performed; otherwise, false.

For internal use.

Unlocks the object after a call to the method and applies changes made to the parameter settings.

Provides access to options related to exporting a dashboard item to the Excel format.

A object containing options related to exporting a dashboard item to the Excel format.

Exports the dashboard item to the specified stream in Excel format.

A that is the component name of the dashboard item to be exported. A object to which the created Excel file should be sent. A object which specifies the Excel export options to be applied when the dashboard item is exported.

Exports the dashboard item to the specified stream in Excel format.

Exports the dashboard item to the specified file in Excel format using specified export options.

A that is the component name of the dashboard item to be exported. A that specifies the path to the Excel file. A object which specifies the Excel export options to be applied when the dashboard item is exported.

Exports the dashboard item to the specified file in Excel format using the specified export options.

Exports the dashboard item to the specified stream in Image format.

A that is the component name of the dashboard item to be exported. A object to which the created image file should be sent.

Exports the dashboard item to the specified stream in Image format using the specified image options.

A that is the component name of the dashboard item to be exported. A object to which the created image file should be sent. A object that specifies the image export options to be applied when the dashboard item is exported.

Exports the dashboard item to the specified stream in Image format using the specified Image-specific options.

A that is the component name of the dashboard item to be exported. A object to which the created image file should be sent. A object that specifies the Image export options to be applied when the dashboard item is exported.

Exports the dashboard item to the specified file in Image format.

A that is the component name of the dashboard item to be exported. A that specifies the path to the Image file.

Exports the dashboard item to the image file using the specified image options.

A that is the component name of the dashboard item to be exported. A that specifies the path to the image file. A object that specifies the image export options to be applied when the dashboard item is exported.

Exports the dashboard item to the specified file in Image format using the specified Image-specific options.

A that is the component name of the dashboard item to be exported. A that specifies the path to the Image file. A object that specifies the Image export options to be applied when the dashboard item is exported.

Exports the dashboard item to the specified stream in PDF format.

A that is the component name of the dashboard item to be exported. A object to which the created PDF file should be sent.

Exports the dashboard item to the specified stream in PDF format using the specified PDF-specific options.

A that is the component name of the dashboard item to be exported. A object to which the created PDF file should be sent. A object which specifies the PDF export options to be applied when the dashboard item is exported.

Exports the dashboard item to the specified stream in PDF format using the specified PDF-specific options.

Exports the dashboard item to the specified file in PDF format.

A that is the component name of the dashboard item to be exported. A that specifies the path to the PDF file.

Exports the dashboard item to the specified file in PDF format using the specified PDF-specific options.

A that is the component name of the dashboard item to be exported. A that specifies the path to the PDF file. A object which specifies the PDF export options to be applied when the dashboard item is exported.

Exports the dashboard item to the specified file in PDF format using the specified PDF-specific options.

Occurs when the Export Form is about to be displayed, and allows you to cancel the action.

Exports dashboard data to the specified stream in Excel format.

A object to which the created Excel file should be sent.

Exports dashboard data to the specified stream in Excel format.

A object to which the created Excel file should be sent. A object containing Excel-specific options.

Exports dashboard data to the specified file in Excel format.

A that specifies the path to the Excel file.

Exports dashboard data to the specified file in Excel format.

A that specifies the path to the Excel file. A object containing Excel-specific options.

Exports a dashboard to the specified stream in Image format.

A object to which the created image file should be sent.

Exports a dashboard to the specified stream in Image format using the specified image-specific options.

A object to which the created image file should be sent. A object that specifies the image export options to be applied when a dashboard is exported.

Exports a dashboard to the specified stream in Image format using the specified Image-specific options.

A object to which the created image file should be sent. A object that specifies the Image export options to be applied when a dashboard is exported.

Exports a dashboard to the specified file in Image format.

A that specifies the path to the Image file.

Exports a dashboard to the specified image file using the specified image-specific options.

A that specifies the path to the image file. A object that specifies the image export options to be applied when a dashboard is exported.

Exports a dashboard to the specified file in Image format using the specified Image-specific options.

A that specifies the path to the Image file. A object that specifies the Image export options to be applied when a dashboard is exported.

Exports a dashboard to the specified stream in PDF format.

A object to which the created PDF file should be sent.

Exports a dashboard to the specified stream in PDF format using the specified PDF-specific options.

A object to which the created PDF file should be sent. A object which specifies the PDF export options to be applied when a dashboard is exported.

Exports a dashboard to the specified stream in PDF format using the specified PDF-specific options.

A object to which the created PDF file should be sent. A object which specifies the PDF export options to be applied when a dashboard is exported.

Exports a dashboard to the specified file in PDF format.

A that specifies the path to the PDF file.

Exports a dashboard to the specified file in PDF format using the specified PDF-specific options.

A that specifies the path to the PDF file. A object which specifies the PDF export options to be applied when a dashboard is exported.

Exports a dashboard to the specified file in PDF format using the specified PDF-specific options.

A that specifies the path to the PDF file. A object which specifies the PDF export options to be applied when a dashboard is exported.

Gets or sets the display style of filter conditions in the Filter Editor.

The display style of filter conditions in the Filter Panel and built-in Filter Editor. When the FilterCriteriaDisplayStyle property is set to Default, the actual display style is specified by the static property.

Use instead.

Returns axis point tuples identifying elements that can be used to perform drill-down in the specified dashboard item.

A that is the component name of the dashboard item. A list of objects identifying elements that can be used to perform drill-down in the specified dashboard item.

Returns data identifying the elements that can be used to perform drill-down in the specified dashboard item. Asynchronous method.

A that is the component name of the dashboard item. The task object that is the asynchronous operation to return a list of objects identifying elements that can be used to perform drill-down in the specified dashboard item.

Returns axis point tuples identifying elements that can be selected in the current state of the master filter item.

A that is the component name of the master filter item. A list of objects identifying elements that can be selected in the current state of the master filter item.

Gets the data (axis point tuples) that identifies selectable elements in the current state of the master filter item.

A that is the component name of the master filter item. The task object that is the asynchronous operation to get a list of objects.

Returns names of the predefined ranges available for the specified Range Filter.

A value that specifies the component name of the Range Filter dashboard item. An array of values that are names of the available predefined ranges.

Returns records identifying elements that can be selected in the current state of the master filter item.

A that is the component name of the master filter item. A object that represents a list of records identifying elements of the master filter item.

Returns an axis point tuple identifying the current drill-down state.

A that is the component name of the dashboard item. An object representing a set of axis points.

Returns axis point tuples identifying currently selected elements in the master filter item.

A that is the component name of the master filter item. A list of objects identifying elements that can be selected in the current state of the master filter item.

Returns the name of the currently selected predefined range.

A value that specifies the component name of the Range Filter or Date Filter dashboard item. A value that is the name of the currently selected predefined range.

Returns the selected range for the specified Range Filter or Date Filter dashboard item.

A that specifies the component name of the Range Filter or Date Filter dashboard item. A object that is the selected range in the specified Range Filter or Date Filter dashboard item.

Returns records identifying currently selected elements in the master filter item.

A that is the component name of the master filter item. A object that represents a list of records identifying currently selected elements.

Gets the current dashboard state.

A object that contains modifications produced by end-user interaction.

Returns the visible range for the specified Range Filter or Date Filter dashboard item.

A that specifies the component name of the Range Filter or Date Filter dashboard item. A object that is the visible range in the specified Range Filter or Date Filter dashboard item.

Returns the visible range for the specified Range Filter or Date Filter dashboard item.

A that specifies the component name of the Range Filter or Date Filter dashboard item. The task object that is the asynchronous operation to return a object.

Returns the client data for the specified dashboard item.

A that specifies the component name of the dashboard item. A object that represents multidimensional data visualized in the dashboard item.

Obtains the displayed data for the specified dashboard item asynchronously.

A that specifies the component name of the dashboard item. The task object that is the asynchronous operation to get the data visualized in the dashboard item.

Gets a printable component corresponding to the specified dashboard item.

A that specifies the component name of the dashboard item. An object that implements the interface, specifying a component to be printed/exported.

Gets a printable control corresponding to the specified dashboard item.

A string that is the dashboard item's component name. A printable control corresponding to the specified dashboard item.

Gets the selected page in the specified tab container.

A that is the property value and identifies the tab container. A that is the property value and identifies the tab page.

Gets the index of the selected page in the specified tab container.

A that is the property value and identifies the tab container. An integer that is the index in the collection.

Gets the underlying control used to visualize data within the specified dashboard item.

A component name of the dashboard item for which you get the underlying control. A DevExpress WinForms control used to visualize data within the dashboard item.

Gets the underlying controls used to visualize data within the dashboard items.

A list of DevExpress WinForms controls used to visualize data within the dashboard items.

Returns a list of records from the dashboard data source for the specified dashboard item.

A that specifies the component name of the dashboard item. A object that is the list of records from the dashboard data source.

Returns underlying data for the specified dashboard item by the specified axis points.

A that specifies the component name of the dashboard item. A list of objects that specify data points in a multidimensional space. A object that represents a list of records from the dashboard data source.

Returns underlying data for the specified dashboard item by the specified axis points.

A that specifies the component name of the dashboard item. A list of objects that specify data points in a multidimensional space. A list of values that specify data member identifiers used to obtain underlying data. A object that represents a list of records from the dashboard data source.

Returns underlying data for the specified dashboard item by the specified dimension values.

A that specifies the component name of the dashboard item. A list of objects that specify the hierarchy of dimension values. A object that represents a list of records from the dashboard data source.

Returns underlying data for the specified dashboard item by the specified dimension values.

A that specifies the component name of the dashboard item. A list of objects that specify the hierarchy of dimension values. A list of values that specify data member identifiers used to obtain underlying data. A object that represents a list of records from the dashboard data source.

Returns underlying data for the specified dashboard item by the specified data members.

A that specifies the component name of the dashboard item. A list of values that specify data member identifiers used to obtain underlying data. A object that represents a list of records from the dashboard data source.

Gets or sets the number of the Grid dashboard item's data rows whose content is processed to apply best fit to columns.

An integer value specifying the number of data rows that are processed to apply best fit to columns.

Handles the dashboard close process.

true, if the dashboard closing has been handled; false, if the dashboard closing has been cancelled.

Provides access to options related to exporting a dashboard/dashboard item to an image.

A object containing options related to exporting a dashboard/dashboard item to an image.

Handle this event to get the dashboard item data, and apply the master filter and dashboard state in asynchronous mode.

Gets whether the dashboard has been modified since the last save.

true, if the dashboard has been modified since the last save; otherwise, false.

Occurs after the dashboard layout is changed.

Loads a dashboard from a stream.

A object that contains the dashboard XML definition.

Loads a dashboard from an XML file.

A that specifies the path to an XML file that contains the dashboard.

Loads a dashboard layout from a stream.

A object that contains the dashboard layout.

Loads a dashboard layout from an XML file.

A that specifies the path to an XML file that contains the dashboard layout.

Occurs when an end-user clears the selection in the master filter item.

Allows you to apply default filtering to master filter items.

Occurs when an end-user changes the state of the master filter.

Expands the specified dashboard item to the entire dashboard size to examine data in greater detail.

A that is the dashboard item component name (the property)

Expands the specified dashboard item to the entire dashboard size in an asynchronous task.

A that is the dashboard item component name (the property) The task object that is the asynchronous operation to complete.

Gets the name of the maximized dashboard item.

A value that is the maximized dashboard item name.

Gets or sets the menu manager that controls the look and feel of the menus.

An object which implements the DevExpress.Utils.Menu.IDXMenuManager interface.

Provides access to dashboard parameter settings and metadata.

A object representing a collection of objects.

Provides access to options related to exporting a dashboard/dashboard item to the PDF format.

A object containing options related to exporting a dashboard/dashboard item to the PDF format.

Performs a drill-down for the required element.

A that species the component name of the dashboard item. A object that identifies the required element.

Performs a drill-down for the required element.

A that specifies the component name of the dashboard item. An object representing a set of axis points.

Performs a drill-down for the required element by its value.

A that specifies the component name of the dashboard item. A value that will be used to perform a drill-down for the required element.

Performs a drill-down for the required element asynchronously.

A that specifies the component name of the dashboard item. A object that identifies the required element. The task object that is the asynchronous operation to complete.

Performs a drill-down for the required element asynchronously.

A that specifies the component name of the dashboard item. A object that identifies the required element. Propagates notification that operations should be canceled. The task object that is the asynchronous operation to complete.

Performs a drill-down for the required element asynchronously.

A that specifies the component name of the dashboard item. An object that can be used to perform drill-down. The task object that is the asynchronous operation to complete.

Performs a drill-down for the required element asynchronously.

A that specifies the component name of the dashboard item. An object that can be used to perform drill-down. Propagates notification that operations should be canceled. The task object that is the asynchronous operation to complete.

Performs a drill-down for the required element by its value, asynchronously.

A that specifies the component name of the dashboard item. A value that is used to perform a drill-down for the required element. The task object that is the asynchronous operation to complete.

Performs a drill-down for the required element by its value, asynchronously.

A that specifies the component name of the dashboard item. A value that is used to perform a drill-down for the required element. Propagates notification that operations should be canceled. The task object that is the asynchronous operation to complete.

Performs a drill-up for the specified dashboard item.

A that specifies the component name of the dashboard item.

Performs a drill-up in the specified dashboard item asynchronously.

A that specifies the component name of the dashboard item. The task object that is the asynchronous operation to complete.

Performs a drill-up in the specified dashboard item asynchronously.

A that specifies the component name of the dashboard item. Propagates notification that operations should be canceled. The task object that is the asynchronous operation to complete.

For internal use.

Allows you to customize a popup menu invoked by end-users in the .

Provides access to options specific to printing and exporting.

A object that contains settings which specify parameters affecting how the dashboard (dashboard items) is printed.

Provides access to options related to printing a dashboard/dashboard item.

A object containing options related to printing a dashboard/dashboard item.

Allows you to customize the Print Preview window at runtime.

Gets or sets the type of Print Preview used to preview dashboard items or the entire dashboard.

The enumeration member that specifies the type of Print Preview used to preview dashboard items or the entire dashboard.

Provides the capability to specify the default selected range in the Range Filter dashboard item.

Gets 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.

true, to include the current date (year/quarter/month/etc.) in the 'Last' and 'Next' newly created predefined periods; otherwise, false.

Allows you to customize the list of predefined periods in the Edit Periods dialog for the Range Filter dashboard item.

Reloads data in the data sources.

Specifies whether the Loading Panel is shown while data is loaded in the data sources.

Reloads data from the data source for the specified dashboard item.

A string that specifies a component name of the dashboard item for which you reload data.

Reloads data in the data sources asynchronously.

The task object that is the asynchronous operation to complete.

Reloads data from the data source for the specified dashboard item asynchronously.

A string that specifies a component name of the dashboard item for which you reload data. The task object that is the asynchronous operation to complete.

Reloads data in the data sources asynchronously.

Propagates notification that operations should be canceled. The task object that is the asynchronous operation to complete.

Restores the item size if an item is expanded to the entire dashboard size (maximized).

Restores the item size if an item is expanded to the entire dashboard size (maximized) in an asynchronous task.

The task object that is the asynchronous operation to complete.

Gets a Ribbon instance for the current Dashboard Designer.

A instance.

Saves a dashboard layout (layout items and layout containers) to a stream.

A object that contains the dashboard layout.

Saves a dashboard layout to a separate XML file.

A that specifies the path to an XML file that contains the dashboard layout.

Gets or sets the currently selected dashboard item.

A descendant that specifies the currently selected dashboard item.

Gets or sets the currently selected data member.

A value that specifies the currently selected data member.

Gets or sets the currently selected data source.

An object implementing the interface that specifies the currently selected data source.

Occurs after the selected data source or query/data member is changed in the Data Source Browser.

Occurs when the selected tab page is changed.

For internal use.

Applies the dashboard state to the loaded dashboard.

A object that contains the dashboard state information.

Applies the dashboard state to the dashboard, asynchronously.

A object that contains the dashboard state information. The task object that is the asynchronous operation to complete.

Applies the dashboard state to the dashboard, asynchronously.

A object that contains the dashboard state information. Propagates notification that operations should be canceled. The task object that is the asynchronous operation to complete.

Allows you to specify the initial dashboard state when loading a dashboard.

Selects required elements in the specified master filter item.

A that specifies the component name of the master filter item. An object that identifies a master filter element.

Selects required elements in the specified master filter item.

A that specifies the component name of the master filter item. A list of objects used to identify master filter elements.

Selects the required elements in the specified master filter item.

A that specifies the component name of the master filter item. A list of objects used to identify master filter elements.

Selects required elements by their values in the specified master filter item.

A that specifies the component name of the master filter item. Values that will be used to select elements in the master filter item.

Selects the specified elements in the specified master filter item.

A that specifies the component name of the master filter item. An object that identifies a master filter element. The task object that is the asynchronous operation to complete.

Selects the specified elements in the specified master filter item.

A that specifies the component name of the master filter item. An object that identifies a master filter element. Propagates notification that operations should be canceled. The task object that is the asynchronous operation to complete.

Selects the elements by their values in the specified master filter item.

A that specifies the component name of the master filter item. A list of objects used to identify master filter elements. The task object that is the asynchronous operation to complete.

Selects the specified elements in the specified master filter item.

A that specifies the component name of the master filter item. A list of objects used to identify master filter elements. Propagates notification that operations should be canceled. The task object that is the asynchronous operation to complete.

Selects the elements by their values in the specified master filter item.

A that specifies the component name of the master filter item. A collection of objects that identifies master filter elements. The task object that is the asynchronous operation to complete.

Selects the specified elements in the specified master filter item.

A that specifies the component name of the master filter item. A collection of objects that identifies master filter elements. Propagates notification that operations should be canceled. The task object that is the asynchronous operation to complete.

Selects the specified elements in the specified master filter item.

A that specifies the component name of the master filter item. A collection of values that are used to select elements in the master filter item. The task object that is the asynchronous operation to complete.

Selects the specified elements in the specified master filter item.

A that specifies the component name of the master filter item. Values that are used to select elements in the master filter item. Propagates notification that operations should be canceled. The task object that is the asynchronous operation to complete.

Selects the required range in the specified Range Filter or Date Filter dashboard item.

A that specifies the component name of the Range Filter or Date Filter dashboard item. A object that specifies a range in the Range Filter or Date Filter dashboard item.

Selects the specified range in the specified dashboard item that is the Range Filter or Date Filter.

A that specifies the component name of the Range Filter or Date Filter dashboard item. A that specifies the name of the predefined range used to perform a selection.

Selects the required range in the specified Range Filter or Date Filter dashboard item asynchronously.

A that specifies the component name of the Range Filter or Date Filter dashboard item. A object that specifies a range in the Range Filter or Date Filter dashboard item. The task object that is the asynchronous operation to complete.

Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously.

A that specifies the component name of the Range Filter or Date Filter dashboard item. A object that specifies a range in the Range Filter or Date Filter dashboard item. Propagates notification that operations should be canceled. The task object that is the asynchronous operation to complete.

Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously.

A that specifies the component name of the Range Filter or Date Filter dashboard item. A that specifies the name of the predefined range used to perform a selection. The task object that is the asynchronous operation to complete.

Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously.

A that specifies the component name of the Range Filter or Date Filter dashboard item. A that specifies the name of the predefined range used to perform a selection. Propagates notification that operations should be canceled. The task object that is the asynchronous operation to complete.

Selects the specified tab page.

A that is the property value and identifies the tab page.

Selects the tab page specified by its index in the specified tab container.

A that is the property value and identifies the tab container. An integer value that is the index in the collection.

Invokes the Dashboard Parameters dialog in the .

Invokes the Data Inspector dialog for the specified dashboard item.

A object that specifies a component name of the dashboard item for which the Data Inspector displays data.

Invokes the Data Inspector dialog with a defined data type for the specified dashboard item.

A object that specifies a component name of the dashboard item for which the Data Inspector displays data. An enumeration value that defines a displayed underlying data.

Invokes the Data Inspector dialog with a defined data type for the specified dashboard item.

A object that specifies a component name of the dashboard item for which the Data Inspector displays data. The task object that is the asynchronous operation to perform.

Invokes the Data Inspector dialog with a defined data type for the specified dashboard item.

A object that specifies a component name of the dashboard item for which the Data Inspector displays data. A enumeration value that defines a displayed underlying data. The task object that is the asynchronous operation to perform.

Invokes the Data Source wizard.

Invokes the dialog that allows end-users to export the entire dashboard to the specified format.

A value that specifies the export format.

Invokes the dialog that allows end-users to export the dashboard item to the specified format.

A value that specifies the component name of the dashboard item to export. A value that specifies the export format. Note that some items (i.e., or ) do not support exporting to the format.

Invokes the Print Preview, which shows the print preview of the dashboard.

Invokes the Ribbon Print Preview Form, which shows the print preview of the dashboard.

Invokes a save confirmation dialog.

true if the can be closed; false if an end-user canceled closing the .

Use instead.

Fires the event for the specified dashboard item.

A that is the dashboard item name accessible using the property.

Fires the event that allows you to customize the dashboard title content.

Updates all extract data sources in the current dashboard asynchronously. Allows you to set custom actions to perform after updating the data and file.

A custom action to perform when the data is updated. A custom action to perform when the file is updated.

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.

A custom action to perform when the data is updated. A custom action to perform when the file is updated. A list of the data source names.

Updates a file containing a data extract.

A value that specifies whether the Loading Panel is shown while an extract file is being updated. A value that specifies the component name of the extract data source. true, if a file containing a data extract has been successfully updated; otherwise, false.

Gets or sets whether to enable the legacy card layout used prior to v17.1.

true, to enable the legacy card layout used prior to v17.1; otherwise, false.

Gets or sets whether to show all items in the filter elements deselected by default.

true, if all items in the filter elements deselected by default; otherwise, false.

Gets the end-user action performed on the .

The object that is the end-user action performed on the .

Provides the capability to check the validity of the custom SQL query used to supply the dashboard with data.

Returns the toolbar from Bars used in the Dashboard Designer.

A Bar Manager that owns the toolbars used in the Dashboard Designer. A value that identifies a contextual toolbar related to a particular dashboard item. A value that identifies a toolbar. A toolbar that meets the specified parameters.

Returns the category from a Ribbon toolbar used in the Dashboard Designer.

A Ribbon toolbar used in the Dashboard Designer. A Ribbon page category. A Ribbon's category that meets the specified parameters.

Returns the page from a Ribbon toolbar used in the Dashboard Designer.

A Ribbon toolbar used in the Dashboard Designer. A Ribbon page category that contains commands related to a particular dashboard item. A Ribbon page. A Ribbon's page that meets the specified parameters.

Lists values used to specify data source types available in the Data Source wizard.

All supported data source types are displayed in the Data Source wizard.

The default set of data source types is displayed in the Data Source wizard.

Identifies the Entity Framework data source type.

Identifies the Microsoft Excel workbook / CSV file data source type.

Identifies the Data Extract data source type.

Identifies the Data Federation data source type.

Identifies the JSON data source type.

Identifies the Object Binding data source type.

Identifies the Olap data source type.

Identifies the Database data source type.

Identifies the XPO (eXpress Persistent Object) data source type.

Contains settings used to customize the Data Source wizard used to create new data sources in the .

Initializes a new instance of the class.

Gets or sets data source types available in the Data Source wizard.

A enumeration value that specifies data source types available in the Data Source wizard.

Determines whether the specified object is equal to the current instance.

The object to compare with the current object. true, if the specified object is equal to the current instance; otherwise, false.

Gets the hash code that corresponds to the value of the current object.

An integer value representing the hash code for the current object.

Resets settings exposed by the class to default values.

Gets or sets whether end-users can select connections from the application configuration file.

true, to allow end-users to select connections from the application configuration file; otherwise, the application configuration file.

Gets or sets whether to show the Data Source wizard page allowing end-users to specify the data source name.

true, to show the Data Source wizard page allowing end-users to specify the data source name; otherwise, false.

Provides access to dashboard layout settings of the control.

Gets or sets the transparency level for the drag/drop indicator.

An integer value that specifies the transparency level (0 to 255) for the drag/drop indicator.

Gets or sets the size of the drag/drop indicator.

An integer value that specifies the size of the drag/drop indicator (in pixels).

Gets or sets the show timeout for the drag indicator.

An integer value that specifies the show timeout (in milliseconds) for the drag indicator.

Gets or sets the update timeout for the drop indicator.

An integer value that specifies the update timeout (in milliseconds) for the drop indicator.

Gets or sets the thickness of the resizing area.

An integer value that specifies the thickness (in pixels) of the resizing area.

Provides data for the ExportFormShowing events.

Initializes a new instance of the class.

Gets or sets whether to show the Export Form.

true, to show the Export Form; otherwise, false.

References a method that handles the ExportFormShowing events.

The event source. The object containing event data.

Lists values that identify the dashboard item area.

Identifies a dashboard item.

Identifies a grid column header.

Identifies a grid column total.

The area does not belong to a dashboard item.

References a method that handles the event.

The event source. A object containing event data.

References a method that handles the event.

The event source. A object containing event data.

Provides data for events related to controls used to visualize data in dashboard items.

Gets an underlying Card control.

A object that is an underlying Card control.

Gets the chart context.

A context used to provide a connection between data item containers from the Values section and underlying control's series.

Gets an underlying chart control.

A object that is the chart control.

Gets the component name of the dashboard item for which the event was raised.

A that is the component name of the dashboard item.

Gets an underlying date filter control.

A object that is the date filter control.

Gets the gauge context.

A context used to provide a connection between data item containers from the Gauges section and underlying control's gauges.

Gets an underlying gauge control.

A object that is the gauge control.

Gets the grid context.

A context used to provide a connection between data item containers from the Columns section and underlying control's columns.

Gets an underlying grid control.

A object that is the grid control.

Gets an underlying map control.

A object that is the map control.

Gets an underlying picture edit control.

A object that is the picture edit control.

Gets an underlying PivotGridControl.

A object that is the PivotGridControl.

Gets an underlying RichEdit control.

A object that is the RichEdit control.

Gets an underlying TreeMap control.

A object that is an underlying TreeMap control.

References a method that handles the event.

The event source. A object that contains event data.

Provides data for the event.

Gets or sets the color of the dashboard item element.

A that is the ARGB color.

Gets the component name of the dashboard item for which the event was raised.

A that is the component name of the dashboard item.

Gets multidimensional data displayed in the dashboard item.

A object that is the multidimensional data.

Gets measures corresponding to the current dashboard item element.

A list of objects that are measures corresponding to the current dashboard item element.

Gets the axis point tuple corresponding to the current dashboard item element.

An object that is the axis point tuple.

References a method that handles the event.

The event source. A object that contains event data.

Provides data for the and events.

Gets the component name of the maximized or restored dashboard item.

A string that is the item value.

Indicates whether the item is maximized or restored to its original size.

True if an item is maximized; otherwise, false.

References a method that handles the and events.

The event source. A DashboardItemMaximizedStateChangedEventArgs object that contains event data.

Provides data for events related to mouse actions.

References a method that handles the events related to mouse actions.

The event source. A object that contains event data.

Provides data for events related to mouse movement or actions.

Initializes a new instance of the class.

A that specifies the component name of the dashboard item.

Gets the name of the dashboard item for which the event has been raised.

A that is the dashboard item name.

References a method that handles the events related to mouse movement or actions.

The event source. A object that contains event data.

Base class for classes that contain event data and provide access to dashboard item's client and underlying data for the visual element located under the test point.

Gets the dashboard item's client data.

A object that represents the client data.

Returns the axis point corresponding to the visual element located under the test point.

An object that is the axis point.

Returns the axis point corresponding to the visual element located under the test point.

A string value returned by the class that specifies the name of the data axis. An object that is the axis point.

Gets a list of deltas corresponding to the visual element located under the test point.

A list of objects containing the delta metadata.

Gets a list of measures corresponding to the visual element located under the test point.

A list of objects that contain the measure metadata.

Returns the slice of client data by the axis point corresponding to the visual element located under the test point.

A that represents the slice of client data.

Returns the slice of client data by the axis point corresponding to the visual element located under the test point.

A string value returned by the class that specifies the name of the data axis. A that represents the slice of client data.

Returns underlying data corresponding to the visual element located under the test point.

A object that represents a list of records from the dashboard data source.

Returns underlying data corresponding to the visual element located under the test point.

A list of values that specifies data members used to obtain underlying data. A object that represents a list of records from the dashboard data source.

Returns underlying data corresponding to the visual element located under the test point.

A string value returned by the class that specifies the name of the data axis whose dimension values are used to obtain underlying data. A object that represents a list of records from the dashboard data source.

Returns underlying data corresponding to the visual element located under the test point.

A string value returned by the class that specifies the name of the data axis whose dimension values are used to obtain underlying data. A list of values that specifies data members used to obtain underlying data. A object that represents a list of records from the dashboard data source.

Contains settings that specify printing and exporting parameters related to individual dashboard items.

Initializes a new instance of the class.

Gets or sets whether a dashboard item caption(s) is included on the printed page.

A value that specifies whether a dashboard item caption(s) is included on the printed page.

Provides data for the event.

Initializes a new instance of the class with specified settings.

A dashboard item for which the event is raised.

Gets a dashboard item for which the event is raised.

A dashboard item for which the event is raised.

Provides data for the / events.

Gets currently selected elements.

A list of objects corresponding to the selected elements.

Gets the component name of the dashboard item for which the event was raised.

A that is the component name of the dashboard item.

References a method that handles the / events.

The event source. A object that contains event data.

Provides data for the / events.

Gets client data visualized within the dashboard item.

A object that is the client data.

Gets or sets the selection mode for dashboard item elements.

A enumeration value specifying the selection mode.

Sets the default selection for the current dashboard item.

A object specifying the axis point used to select the default element.

Sets the default selection for the current dashboard item.

A object specifying the axis point tuple used to select the default element.

Sets the default selection for the current dashboard item.

A list of objects specifying axis points used to select the default elements.

Sets the default selection for the current dashboard item.

A list of objects specifying axis point tuples used to select default elements.

Gets or sets data axes used to perform custom interactivity actions.

A list of objects that specify the names of data axes.

References a method that handles the event.

The event source. A object that contains event data.

Provides data for the DashboardLoaded events.

Gets the loaded dashboard.

A object that is the loaded dashboard.

References a method that handles the DashboardLoaded events.

The event source. A object that contains event data.

The exception that occurs when the dashboard is locked for further modifications.

Initializes a new instance of the class.

Provides data for the event.

Initializes a new instance of the class.

Gets or sets the dashboard that will be opened.

A object that should be opened by the .

Gets or sets whether the dashboard to be opened has been provided.

true, if the dashboard to be opened has been provided and no default actions are required; otherwise, false.

References a method that handles the event.

The event source. A object that contains event data.

Contains the parameter settings and metadata.

Gets the default parameter value.

A default parameter value.

Gets the parameter's description displayed to an end-user.

A that is the parameter's description displayed to an end-user.

Gets a parameter name.

A that is the parameter name.

Gets or sets a currently selected parameter value.

A currently selected parameter value.

Gets or sets a collection of currently selected parameter values.

A collection of currently selected parameter values.

Gets a parameter type.

A enumeration value that is the type of a dashboard parameter value.

Gets or sets the current parameter value.

An object that specifies the current parameter value.

Gets possible parameter values.

A list of objects that contain parameter values and display texts.

Represents a collection of objects.

Provides access to individual elements in the collection.

An that represents the parameter name. A object containing the parameter settings and metadata.

Represents a dashboard popup menu, managed by a or .

Initializes a new instance of the class.

A object representing the component used to create and manage bars and individual bar items.

Initializes a new instance of the class with the specified container.

An object which implements the interface.

Provides data for the and the events.

Gets or sets whether end-users can invoke a popup menu.

true, to allow end-users to invoke the popup menu; otherwise, false.

Gets the type of the clicked command button.

A enumeration value that is the type of the command button.

Gets the value that identifies a popup menu location within the dashboard.

A enumeration value that identifies a popup menu location within the dashboard.

Gets the area of the dashboard item for which the event has been raised.

A enum value that specifies the dashboard item area.

Gets or sets a popup menu.

A object that specifies the popup menu.

A method that handles the and the events.

The event source. A object that contains event data.

Lists values that specify the filter state's location on the printed or exported document.

The filter state is placed below the dashboard (dashboard item) in the printed document.

The filter state is not included in the printed document.

The filter state is placed on a separate page in the printed document.

Contains settings that specify parameters affecting how the dashboard (dashboard item) is printed or exported.

Initializes a new instance of the class.

Gets or sets the number of horizontal/vertical pages spanning the total width/height of a dashboard (dashboard item).

An integer value that specifies the number of horizontal/vertical pages spanning the total width/height of a dashboard (dashboard item).

Provides access to options specific to printing a card dashboard item.

A object containing settings that specify parameters affecting how the card dashboard item is printed.

Provides access to options specific to printing a chart dashboard item.

A object containing settings that specify parameters affecting how the chart dashboard item is printed.

Provides access to dashboard options specific to printing individual dashboard items.

A object that contains settings specific to printing individual dashboard items.

Provides access to options specific to printing additional content.

A object containing options specific to printing additional content.

Provides access to the font settings of the printed document.

A object containing the font settings of the printed document.

Provides access to options specific to printing a gauge dashboard item.

A object containing settings that specify parameters affecting how the gauge dashboard item is printed.

Provides access to options specific to printing a grid dashboard item.

A object containing settings that specify parameters affecting how the grid dashboard item is printed.

Provides access to options specific to printing map dashboard items.

A object containing settings that specify parameters affecting how map dashboard items are printed.

Gets or sets the page orientation used to print a dashboard (dashboard item).

A enumeration value that specifies the page orientation used to print a dashboard (dashboard item).

Gets or sets the standard paper size.

A enumeration value that specifies the standard paper size.

Provides access to options specific to printing a pie dashboard item.

A object containing settings that specify parameters that affect how pie dashboard items are printed.

Provides access to options specific to printing a pivot dashboard item.

A object containing settings that specify parameters that affect how pivot dashboard items are printed.

Provides access to options specific to printing a Range Filter dashboard item.

A object containing settings that specify parameters affecting how a Range Filter dashboard item is printed.

Gets or sets the scale factor (in fractions of 1), by which a dashboard (dashboard item) is scaled.

A value that specifies the scale factor (in fractions of 1), by which a dashboard (dashboard item) is scaled.

Gets or sets the mode for scaling when printing a dashboard (dashboard item).

A enumeration value that specifies the mode for scaling when printing a dashboard (dashboard item).

Provides access to options specific to printing a Treemap dashboard item.

A object containing settings that specify parameters affecting how the Treemap dashboard item is printed.

Lists values that specify the page orientation used to print or export a dashboard (dashboard item).

The page orientation used to print a dashboard (dashboard item) is landscape.

The page orientation used to print a dashboard (dashboard item) is portrait.

Lists values that specify the scale mode used to print or export the dashboard (dashboard item).

The size of the dashboard(dashboard item) is changed according to the width of the printed page.

The size of the dashboard(dashboard item) is changed to fit its content on a single page.

The dashboard (dashboard item) on the printed page retains its original size.

The size of the dashboard (dashboard item) on the printed page is changed according to the scale factor value.

Lists values that specify the type of the Print Preview.

A ribbon toolbar is used in the Print Preview.

A standard toolbar is used in the Print Preview.

Contains values that identifies a ribbon page when the Dashboard Designer uses Ribbon UI.

Identifies the Data contextual page.

A Ribbon's page for the Dashboard Designer's Ribbon UI.

Identifies the Data Source main page.

A Ribbon's page for the Dashboard Designer's Ribbon UI.

Identifies the Design contextual page.

A Ribbon's page for the Dashboard Designer's Ribbon UI.

Identifies the Home main page.

A Ribbon's page for the Dashboard Designer's Ribbon UI.

Identifies the View contextual page.

A Ribbon's page for the Dashboard Designer's Ribbon UI.

Lists values that specify save commands.

An end-user has called the Save command.

An end-user has called the Save As command.

Provides data for the event.

Initializes a new instance of the class.

A object. A that is the path to the dashboard XML definition before the save operation. A that is the path to the dashboard XML definition after the save operation.

Gets the saved dashboard.

A object that is the saved dashboard.

Gets the path to the dashboard XML definition after the save operation.

A that is the path to the dashboard XML definition after the save operation.

Gets the path to the dashboard XML definition before the save operation.

A that is the path to the dashboard XML definition before the save operation.

References a method that handles the event.

The event source. A object that contains event data.

Provides data for the event.

Initializes a new instance of the class.

A object that should be serialized. A enumeration member that specifies which action raised this event.

Gets which user action raised the event.

A enumeration member that specifies the user action that triggered the event.

Gets the dashboard that should be saved.

A object that should be serialized.

Gets or sets whether default actions are required to save the dashboard.

true, if no default actions are required to save the dashboard; otherwise, false.

Gets or sets whether the custom save routine has succeeded.

true, if the custom save routine has succeeded; false if it has failed.

References a method that handles the event.

The event source. A object that contains event data.

Lists values that specify the selection mode for the Master-Filtering feature.

Allows selecting multiple elements within the dashboard item.

The selection is disabled.

Allows selecting a single element within the dashboard item and disallows clearing this selection.

Lists values used to specify SQL data providers available in the Data Source wizard.

Identifies Micrisoft Access data providers.

Identifies the SAP Sybase Advantage data provider.

All supported data providers are displayed in the Data Source wizard.

Identifies the SAP SQL Anywhere data provider.

Identifies the SAP Sybase ASE data provider.

Identifies the Google BigQuery data provider.

Identifies the Custom Connection String data provider.

Identifies the IBM DB2 data provider.

Identifies the Firebird data provider.

Identifies the Microsoft SQL Server data provider.

Identifies the MS SQL Server CE data provider.

Identifies the MySQL data provider.

Identifies the Oracle data provider.

Identifies the Pervasive PSQL data provider.

Identifies the Postgre SQL data provider.

Identifies the Amazon Redshift data provider.

Identifies the SQLite data provider.

Identifies the Teradata data provider.

Identifies VistaDB data providers.

Identifies the XML File data provider.

Provides data for the DashboardStateChanged event.

Gets the current state of the dashboard.

A DashboardState object that contains the selected master filter values, drill-down levels, and other client actions users perform on a dashboard.

References a method that handles the DashboardStateChanged event.

The event source. A object that contains event data.

Contains values that identifies a toolbar when the Dashboard Designer uses Bar UI.

Identifies the Data Source toolbar.

A toolbar for the Dashboard Designer's Bar UI.

Identifies the Home toolbar.

A toolbar for the Dashboard Designer's Bar UI.

Identifies a contextual toolbar related to a particular dashboard item.

A toolbar for the Dashboard Designer's Bar UI.

Identifies the View toolbar.

A toolbar for the Dashboard Designer's Bar UI.

An element, contained in the dashboard title or dashboard item caption, such as a command button.

Initializes a new instance of the class with default settings.

Initializes a new instance of the class with the specified click action.

A delegate method that specifies an action performed after clicking the command button.

Initializes a new instance of the class with the specified checked state, tooltip and click action.

True, to create a button in a checked state; otherwise, false. A delegate method that specifies an action performed after clicking the command button.

Initializes a new instance of the class with the specified checked state, tooltip and click action.

True, to create a button in a checked state; otherwise, false. A that is the text displayed in a tooltip. A delegate method that specifies an action performed after clicking the command button.

Initializes a new instance of the class with the specified setting.

A that is the text displayed in the tooltip.

Initializes a new instance of the class with the specified tooltip and click action.

A that is the text displayed in a tooltip. A delegate method that specifies an action performed after clicking the command button.

Gets or sets a raster image displayed within the item.

A object that is the image displayed within the element located in the dashboard title or dashboard item caption.

Gets the type of the clicked command button.

A enumeration value that is the type of the command button.

Gets or sets the text displayed within the item.

A that is the text displayed witin the item.

Gets a value indicating whether the item is in the pushed state.

True, if the item is currently in the pushed state; null if the item cannot be pushed or checked; otherwise, false.

Gets or sets an action performed after clicking the item (the command button).

A delegate method that specifies an action performed after clicking the command button.

Disposes of the current object and releases all its unmanaged resources.

Gets or sets whether the item is active.

True, if the current item is active; otherwise, false.

Gets a collection of objects associated with the menu.

Gets or sets a SuperToolTip for the current control.

A object associated with the item.

Gets or sets a vector image displayed within the item.

A object that is the vector image displayed within the element located in the dashboard title or dashboard item caption.

Gets or sets custom data associated with the item.

An object that contains additional information stored with the item.

Gets or sets the text displayed in a regular tooltip.

A text displayed as an item tooltip.

Provides data for the action performed after clicking the command button in the dashboard title or dashboard item caption.

Provides access to an element being clicked.

An element, located in the dashboard title or dashboard item caption, such as a command button.

Drop-down menu element, contained in the dashboard title or dashboard item caption.

Initializes a new instance of the class with the specified checked state, caption and click action.

True, to create a button in a checked state; otherwise, false. A that is the menu item caption text. A delegate method that specifies an action performed after clicking the menu item.

Initializes a new instance of the class with the specified caption and click action.

A that is the text displayed in a menu item caption. A delegate method that specifies an action performed after clicking the menu item.

Gets or sets the text displayed within the item.

A that is the text displayed witin the item.

Gets a value indicating whether the item is in the pushed state.

True, if the item is currently in the pushed state; null if the item cannot be pushed or checked; otherwise, false.

Provides access to properties that allow you to set up raster and vector images for the menu item.

A DevExpress.Utils.ImageOptions object that stores image-related settings.

Gets or sets custom data associated with the item.

An object that contains additional information stored with the item.

A Dashboard Viewer control used to embed dashboards created in the Dashboard Designer into a WinForms application.

Initializes a new instance of the class with default settings.

Initializes a new instance of the class with the specified container.

An object implementing the interface which specifies the owner container of a class instance.

Activates the control's About dialog box.

Gets or sets whether to display aggregated data in the Data Inspector.

true, to display aggregated data in the Data Inspector; otherwise, false.

Gets or sets whether to display raw data in the Data Inspector.

true, to display raw data in the Data Inspector; otherwise, false.

Gets or sets whether to enable the animation when you maximize or restore dashboard items.

True, to enable the animation; otherwise, false.

Gets or sets whether end users can maximize dashboard items.

true, to allow maximizing dashboard items; otherwise, false.

Gets or sets whether end-users can print or export a dashboard.

true, if end-users can print/export a dashboard; otherwise, false.

Gets or sets whether end-users can print or export dashboard items.

true, if end-users can print/export dashboard items; otherwise, false.

Allows you to provide data for the in asynchronous mode.

Allows you to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files asynchronously.

Gets or sets whether DashboardViewer operates in asynchronous mode.

true, to use asynchronous mode; otherwise, false.

Allows you to validate a custom SQL query of the in asynchronous mode.

Occurs when an end-user tries to export a dashboard (dashboard item) to the required format.

Allows you to hide specific dashboard items when printing or exporting the entire dashboard.

Locks the object until the method call.

Gets or sets whether to calculate totals for the hidden data items.

true, to calculate hidden totals; otherwise, false.

Returns whether the specified master filter can be cleared in the current state.

A that specifies the component name of the dashboard item. true, if the specified master filter can be cleared in the current state; otherwise, false.

Returns whether drill down is possible in the current state of the specified dashboard item.

A that specifies the component name of the dashboard item. true, if drill down is possible in the current state of the specified dashboard item; otherwise, false.

Returns whether drill up is possible in the current state of the specified dashboard item.

A that specifies the component name of the dashboard item. true, if drill up is possible in the current state of the specified dashboard item; otherwise, false.

Returns whether the master filter item allows selecting one or more elements.

A that specifies the component name of the dashboard item. true, if the master filter item allows selecting one or more elements; otherwise, false.

Returns whether the master filter item allows selecting multiple elements.

A that specifies the component name of the dashboard item. true, if the master filter item allows selecting multiple elements; otherwise, false.

Clears the specified master filter item.

A that specifies the component name of the dashboard item.

Clears the specified master filter item in asynchronous mode.

A that specifies the component name of the dashboard item. The task object that is the asynchronous operation to complete.

Clears the specified master filter item in asynchronous mode.

A that specifies the component name of the dashboard item. Propagates notification that operations should be canceled. The task object that is the asynchronous operation to complete.

Allows you to customize connection settings before the connects to a data store (database, OLAP cube, etc.).

Allows overriding the default behavior when current connection parameters do not allow connecting to a data store.

Occurs before a custom assembly is loaded for use as .

Allows you to specify a custom schema for the SQL Data Source.

An object that implements the interface that provides a custom schema.

Allows you to customize the exported document.

Allows you to include WHERE clauses into queries.

Allows you to customize the dashboard item caption at runtime.

Allows you to customize the dashboard title at runtime.

Allows you to customize the text displayed within the dashboard title at runtime.

Allows you to customize the exported document.

Allows you to substitute the default palette containing colors used to paint dashboard item elements.

Occurs before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing.

Gets or sets the currently opened dashboard.

A object that is the currently opened dashboard.

Occurs after a dashboard has been opened.

Occurs when the custom property value in the Dashboard Viewer is changed.

Allows you to access underlying WinForms controls.

Occurs when an end user clicks a dashboard item.

Allows you to access underlying WinForms controls.

Occurs when an end user double-clicks a dashboard item.

Allows you to color the required dashboard item elements using the specified colors.

Fires when an item becomes maximized or restores its original size.

Occurs when the mouse pointer is over the dashboard item and a mouse button is pressed.

Occurs when the mouse pointer enters the dashboard item.

Occurs when the mouse pointer rests on the dashboard item.

Occurs when the mouse pointer leaves the dashboard item.

Occurs when the mouse pointer is moved over the dashboard item.

Occurs when the mouse pointer is over the dashboard item and a mouse button is released.

Occurs when the mouse wheel moves while the dashboard item has focus.

Occurs after the selection within the dashboard item is changed.

Allows you to provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting.

Occurs after the dashboard is loaded to the .

Gets or sets a dashboard supplier for the .

A value specifying a dashboard supplier for the .

Occurs after the current dashboard state in the is changed.

Gets or sets the URI of the dashboard.

A object that specifies the URI of the dashboard.

Occurs before the Data Inspector window closes. Allows you to access the window's grid controls.

Occurs before the Data Inspector window displays. Allows you to access the window's grid controls and change their settings.

Allows you to provide data for the .

Allows you to suppress the form containing errors that occur during data loading.

Provides access to options that define the data source options of a .

A object containing options that define the data source options of a .

Occurs after drill-down is performed.

Occurs after a drill-up is performed.

Gets or sets whether the displays a Wait Form when a time-consuming operation is performed.

true, if the displays a Wait Form when a time-consuming operation is performed; otherwise, false.

Unlocks the object after a call to the method and applies changes made to the parameter settings.

Provides access to options related to exporting a dashboard item to the Excel format.

A object containing options related to exporting a dashboard item to the Excel format.

Exports the dashboard item to the specified stream in Excel format using specified export options.