DevExpress.Dashboard.v23.1.Wpf

Contains classes that implement the WPF Dashboard functionality.

Provides data for the event.

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

A value that specifies a component name of the dashboard item.

Gets or sets whether to calculate totals which are not displayed in the dashboard item.

True, to calculate hidden totals; otherwise, false.

Gets the component name of the dashboard item.

A that specifies the component name of the dashboard item.

A method that handles the event.

The event source. The object containing event data.

Provides data for the event.

Initializes a new instance of the class.

A that is the data source name. A that is the connection name. A descendant containing connection parameters. A object that is the exception that caused the connection error.

Gets the data source name.

A that is the data source name.

A method that handles the event.

The event source. A object containing event data.

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

Initializes a new instance of the class.

Gets or sets whether to enable the animation when you maximize or restore dashboard items. This is a dependency property.

True, to enable the animation; otherwise, false.

Identifies the dependency property.

A dependency property.

Gets whether the animation is being played.

true, if the animation is in progress; otherwise, false.

Allows you to provide data for the .

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

Enables you to check the validity of the custom SQL query used to supply the dashboard with data.

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

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 is 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 users to select one or more elements.

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

Returns whether the master filter item allows users to select multiple elements.

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

Clears the specified master filter item.

A that specifies the component name of the dashboard item.

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

Allows you to configure how the dashboard item’s client data is calculated.

Allows users to override the default behavior when data store connection fails with current connection parameters.

Occurs before a custom assembly is loaded for use as .

Occurs before you save the exported document to the PDF and Image formats and allows you to customize the exported document.

Allows you to include WHERE clauses into queries.

Allows you to customize the stream containing the resulting document (such as PDF, Image, or Excel).

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 opened dashboard.

A object that is the opened dashboard.

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

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

Occurs when the mouse pointer enters the dashboard item.

Occurs when the mouse pointer enters the dashboard item.

Occurs when the mouse pointer moves over a 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 loads a dashboard.

Identifies the DashboardControl.Dashboard dependency property.

A dependency property.

Gets or sets a dashboard source for the .

An that specifies a dashboard source for the .

Identifies the DashboardControl.DashboardSource dependency property.

A dependency property.

Occurs after the current dashboard state in the is changed.

This member supports internal infrastructure and is not intended to be used directly from your code.

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

Occurs after a drill-down is performed.

Occurs after a drill-up is performed.

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

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

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

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.

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

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.

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

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.

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

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

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

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

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 stream in Excel format.

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

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 dashboard data to the specified file in Excel format.

A that specifies the path to the Excel file.

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.

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

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.

A that specifies the path to the Image file.

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.

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

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.

A that specifies the path to the PDF file.

This member supports internal infrastructure and is not intended to be used directly from your code.

Identifies the dependency property.

A dependency property.

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

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

Saves dashboard layout to a string.

A that is the dashboard layout representation.

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 client data for the specified dashboard item.

A that specifies the component name of the dashboard item. A object that is 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.

Returns a component name of the selected tab page in the specified tab container.

A that is the component name. A that is the component name.

Returns an index of the selected tab page in the specified tab container.

A that is the component name. A that is the component name.

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

Returns underlying data for the specified dashboard item.

A that specifies the component name of the dashboard item. 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.

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 as an image.

Schedules the asynchronous data update for the entire dashboard. The data update is performed when the method is called.

Schedules the asynchronous data update for the specified dashboard item. The data update is performed when the method is called.

A object that is a dashboard item name.

Occurs after the dashboard layout is changed.

Loads a dashboard from a stream.

A object that contains the dashboard.

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 (layout items and layout containers) from an XML file.

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

Gets or sets whether the control loads data for dashboard items on the initially inactive tab pages. This is a dependency property.

true, to load data in the inactive tab pages; otherwise, false.

Identifies the DashboardControl.LoadInactiveTabs dependency property.

A dependency property identifier.

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

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

Gets or sets the name of the maximized dashboard item. This is the dependency property.

A value that is a maximized dashboard item’s name.

Identifies the dependency property.

A dependency property.

Specifies how to load the object data sources available in the end-user application considering the application security.

A enumeration member that specifies whether to allow loading object data sources or prompt the user for confirmation.

Identifies the dependency property.

A dependency property.

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

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

Performs a drill-down for the required element.

A that specifies 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-up in the specified dashboard item.

A that specifies the component name of the dashboard item.

Provides access to options that the Print Preview window uses to print a dashboard/dashboard item.

A object that contains print options.

Reloads data from the data source for the entire dashboard.

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

A object that is a dashboard item name.

Reloads data from the specified data source. Accepts data source object as the parameter. You can propagate a notification to cancel it.

An object that specifies the data source. A object to monitor for cancellation requests.

Reloads data from the specified data source instance.

An object that specifies the data source.

Reloads data from the specified data source. Accepts data source component name as the parameter. You can propagate a notification to cancel it.

A value that specifies the data source component name. A object to monitor for cancellation requests.

Reloads data from the specified data source. Accepts data source component name as the parameter.

A value that specifies the data source component name.

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

A object that contains the dashboard layout.

Saves a dashboard layout (layout items and layout containers) to a separate XML file.

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

Occurs when the selected tab page is changed.

Applies dashboard layout contained in a string.

A that is the dashboard layout representation.

Applies the dashboard state to the loaded dashboard.

A object.

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 are used to select elements in the master filter item.

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 Range Filter or Date Filter dashboard item.

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 page specified by its parent container name and by the index in the page collection.

A that is the component name. An integer that is the page index in the collection.

Selects the page specified by its component name.

A that is the component name.

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

A object, that is a dashboard item’s name.

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 object that defines a displayed underlying data.

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 dialog that allows end users to export the entire dashboard to the specified format.

A DashboardExportFormat value that specifies the export format.

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

A that specifies the dashboard item’s component name. A DashboardExportFormat value that specifies the export format.

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

Gets or sets the horizontal alignment of the dashboard title content, excluding command buttons. This is a dependency property.

The enumeration member that specifies horizontal alignment.

Identifies the dependency property.

A dependency property.

Gets or sets the title text. This is a dependency property.

An object displayed in the dashboard title. Specify a to display text.

Identifies the dependency property.’

A dependency property.

Allows you to specify a template to display in the dashboard title (command buttons are not affected).

A object that specifies the data template for the dashboard title content.

Identifies the dependency property.

A dependency property.

Gets or sets an object that returns a template based on custom logic. This is a dependency property.

An object that applies templates based on custom logic.’

Identifies the dependency property.

A dependency property.

Gets or sets whether the dashboard title is displayed.

A enumeration member that specifies whether the dashboard title is displayed.

Identifies the dependency property.

A dependency property.

Performs the scheduled data update asynchronously.

Updates the specified extract data sources in the current dashboard asynchronously. Allows you to specify 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. The task object that is the asynchronous operation to complete.

Updates all extract data sources in the current dashboard asynchronously. Allows you to specify 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. The task object that is the asynchronous operation to complete.

Provides data for events related to mouse actions.

Gets the data displayed in the dashboard item.

A object that is the dashboard item data.

Obtains the AxisPoint object located at the top priority axis and related to the visual element under the test point.

An object that is the axis point in the multidimensional data concept.

Obtains the AxisPoint object located at the specified axis and related to the visual element under the test point.

A string that specifies the name of the data axis. An object that is the data axis point.

Gets a list of delta descriptors related to the visual element located under the test point.

A list of objects containing the delta metadata.

Gets a list of measure descriptors related to the visual element located under the test point.

A list of objects containing the measure metadata.

Returns the data slice for the Default axis by the AxisPoint related to the visual element located under the test point.

A object that is the slice of the client data.

Returns the data slice for the specified axis by the AxisPoint related to the visual element located under the test point.

A string that is the standard data axis name. A object that is the slice of the client data.

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

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

Returns underlying data related 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 is a list of records from the dashboard data source.

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

A string value that is 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 is a list of records from the dashboard data source.

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

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

A method that handles the , , and events.

The event source. A object containing event data.

Provides data for events related to mouse movements.

Initializes a new instance of the class.

The name of the dashboard item.

Gets the name of the dashboard item.

A that is the name of the dashboard item.

A method that handles the , and events.

The event source. A object containing event data.

Provides data for the event.

Gets currently selected elements’ data.

A list of objects corresponding to the selected elements.

Gets the name of the dashboard item that is the event’s source.

A that is the dashboard item’s name.

A method that handles the event.

The event source. A object containing event data.

Provides data for the event.

A method that handles the event.

The event source. A object containing event data.

Provides data for the event.

Initializes a new instance of the class.

A dashboard to load.

A object to assign to the property.

A method that handles the event.

The event source. A object containing event data.

Provides data for the 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.

A data-context for a Dashboard Control and Dashboard items that provides access to the .

Initializes a new instance of the class.

Gets the instance to access a dashboard and the DashboardControl API.

A

Gets the name of the dashboard item.

A that is the name of the dashboard item.

Provides data for the event.

Gets the component name of the Excel data source for which the event was raised.

A value that is the component name of the Excel data source for which the event was raised.

Gets the name of the Excel data source for which the event was raised.

A value that is the name of the Excel data source for which the event was raised.

Gets or sets a path to the Microsoft Excel workbook or CSV file.

A that specifies the path to the Microsoft Excel workbook or CSV file.

Gets or sets options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files.

A descendant containing options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files.

Gets or sets a stream that contains a Microsoft Excel workbook or CSV file.

A object containing a Microsoft Excel workbook or CSV file.

Gets or sets the format of the document contained in the ExcelDataSourceBeforeFillWpfEventArgs.Stream.

A enumeration value that specifies the format of the document contained in the ExcelDataSourceBeforeFillWpfEventArgs.Stream.

A method that will handle the event.

The event source. A object that contains event data.

Allows you to access and manage a DashboardControl API.

Gets or sets the opened dashboard.

A object

Gets the dashboard state.

A object that contains changes users made.

Returns the client data for the specified dashboard item.

A that is the component name of the dashboard item. A object that is the data visualized in the dashboard item.

Provides data for the visual point on the dashboard item.

Gets the dashboard item component name.

A that is the DashboardItem.ComponentName value.

Gets the axis point for the specified axis by the specified values.

A string value contained in the class that specifies the name of the data axis. A list of values identifying the required point. An object that is the data point on the specified axis.

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

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 is a list of records from the dashboard data source.

Provides access to the dashboard item client data.

A object containing data displayed in the dashboard item.

Provides data for the event.

A method that will handle the event.

The event source. A object that contains event data.

Dimension value used to obtain the underlying data.

Initializes a new instance of the class.

Gets or sets the dimension identifier used to obtain the underlying data.

A that specifies the dimension identifier used to obtain the underlying data.

Gets or sets the dimension value used to obtain the underlying data.

The dimension value used to obtain the underlying data.