IDashboardControl Members
In This Article
#Properties
Name | Description |
---|---|
Allow |
Gets or sets whether to display aggregated data in the Data Inspector. |
Allow |
Gets or sets whether to display raw data in the Data Inspector. |
Allow |
Gets or sets whether to enable the animation when you maximize or restore dashboard items. |
Allow |
Gets or sets whether end users can maximize dashboard items. |
Allow |
Gets or sets whether end-users can print or export a dashboard. |
Allow |
Gets or sets whether end-users can print or export dashboard items. |
Async |
Gets or sets whether Dashboard |
Calculate |
Gets or sets whether to calculate totals for the hidden data items. |
Custom |
Specifies the IDBCommand |
Custom |
Specifies the IDBConnection |
Custom |
Allows you to specify a custom schema for the SQL Data Source. |
Dashboard | Gets or sets the currently opened dashboard. |
Data |
Provides access to options that define the data source options of a Dashboard |
Enable |
Gets or sets whether the Dashboard |
Excel |
Provides access to options related to exporting a dashboard item to Excel format. |
Grid |
Gets or sets the number of the Grid dashboard item’s data rows whose content is processed to apply best fit to columns. |
Image |
Provides access to options related to exporting a dashboard/dashboard item to an image. |
Maximized |
Gets the name of the maximized dashboard item. |
Parameters | Provides access to dashboard parameter settings and metadata. |
Pdf |
Provides access to options related to exporting a dashboard/dashboard item to PDF format. |
Print |
Provides access to options related to printing a dashboard/dashboard item. |
Print |
Gets or sets the type of Print Preview used to preview dashboard items or the entire dashboard. |
Use |
Gets or sets whether to show all items in the filter elements deselected by default. |
User |
Gets the end-user action performed on the Dashboard |
#Methods
Name | Description |
---|---|
Begin |
Locks the Dashboard |
Can |
Returns whether the specified master filter can be cleared in the current state. |
Can |
Returns whether drill down is possible in the current state of the specified dashboard item. |
Can |
Returns whether drill up is possible in the current state of the specified dashboard item. |
Can |
Returns whether the master filter item allows users to select one or more elements. |
Can |
Returns whether the master filter item allows users to select multiple elements. |
Clear |
Clears the specified master filter item. |
Clear |
Clears the specified master filter item in asynchronous mode. |
Clear |
Clears the specified master filter item in asynchronous mode. |
End |
Unlocks the Dashboard |
Export |
Exports the dashboard item to the specified stream in Excel format. |
Export |
Exports the dashboard item to the specified file in Excel format using the specified export options. |
Export |
Exports the dashboard item to the specified stream in Image format using the specified image options. |
Export |
Exports the dashboard item to the specified stream in Image format. |
Export |
Exports the dashboard item to the image file using the specified image options. |
Export |
Exports the dashboard item to the specified file in Image format. |
Export |
Exports the dashboard item to the specified stream in PDF format using the specified PDF-specific options. |
Export |
Exports the dashboard item to the specified stream in PDF format. |
Export |
Exports the dashboard item to the specified file in PDF format using the specified PDF-specific options. |
Export |
Exports the dashboard item to the specified file in PDF format. |
Export |
Exports dashboard data to the specified stream in Excel format. |
Export |
Exports dashboard data to the specified stream in Excel format. |
Export |
Exports dashboard data to the specified file in Excel format. |
Export |
Exports dashboard data to the specified file in Excel format. |
Export |
Exports a dashboard to the specified stream in Image format using the specified image-specific options. |
Export |
Exports a dashboard to the specified stream in Image format. |
Export |
Exports a dashboard to the specified image file using the specified image-specific options. |
Export |
Exports a dashboard to the specified file in Image format. |
Export |
Exports a dashboard to the specified stream in PDF format using the specified PDF-specific options. |
Export |
Exports a dashboard to the specified stream in PDF format. |
Export |
Exports a dashboard to the specified file in PDF format using the specified PDF-specific options. |
Export |
Exports a dashboard to the specified file in PDF format. |
Get |
Returns data identifying the elements that can be used to perform drill-down in the specified dashboard item. |
Get |
Returns data identifying the elements that can be used to perform drill-down in the specified dashboard item. Asynchronous method. |
Get |
Returns axis point tuples identifying elements that can be selected in the current state of the master filter item. |
Get |
Gets the data (axis point tuples) that identifies selectable elements in the current state of the master filter item. |
Get |
Returns names of the predefined ranges available for the specified Range Filter / Date Filter. |
Get |
Returns an axis point tuple identifying the current drill-down state. |
Get |
Returns axis point tuples identifying currently selected elements in the master filter item. |
Get |
Returns the name of the currently selected predefined range. |
Get |
Returns the selected range for the specified Range Filter or Date Filter dashboard item. |
Get |
Returns records identifying currently selected elements in the master filter item. |
Get |
Gets the current dashboard state. |
Get |
Returns the visible range for the specified Range Filter or Date Filter dashboard item. |
Get |
Returns the visible range for the specified Range Filter or Date Filter dashboard item. |
Get |
Returns the client data for the specified dashboard item. |
Get |
Obtains the displayed data for the specified dashboard item asynchronously. |
Get |
Gets a printable control corresponding to the specified dashboard item. |
Get |
Gets the selected page in the specified tab container. |
Get |
Gets the index of the selected page in the specified tab container. |
Get |
Gets the underlying control used to visualize data within the specified dashboard item. |
Get |
Gets the underlying controls used to visualize data within the dashboard items. |
Get |
Returns underlying data for the specified dashboard item by the specified axis points. |
Get |
Returns underlying data for the specified dashboard item by the specified axis points. |
Get |
Returns underlying data for the specified dashboard item by the specified dimension values. |
Get |
Returns underlying data for the specified dashboard item by the specified dimension values. |
Get |
Returns underlying data for the specified dashboard item by the specified data members. |
Get |
Returns underlying data for the specified dashboard item. |
Load |
Loads a dashboard from a stream. |
Load |
Loads a dashboard from an XML file. |
Load |
Loads a dashboard layout (layout items and layout containers) from a stream. |
Load |
Loads a dashboard layout from an XML file. |
Maximize |
Expands the specified dashboard item to the entire dashboard size to examine data in greater detail. |
Maximize |
Expands the specified dashboard item to the entire dashboard size in an asynchronous task. |
Perform |
Performs a drill-down for the required element. |
Perform |
Performs a drill-down for the required element. |
Perform |
Performs a drill-down for the required element by its value. |
Perform |
Performs a drill-down for the required element asynchronously. |
Perform |
Performs a drill-down for the required element asynchronously. |
Perform |
Performs a drill-down for the required element asynchronously. |
Perform |
Performs a drill-down for the required element asynchronously. |
Perform |
Performs a drill-down for the required element asynchronously. |
Perform |
Performs a drill-down for the required element asynchronously. |
Perform |
Performs a drill-up in the specified dashboard item. |
Perform |
Performs a drill-up in the specified dashboard item asynchronously. |
Perform |
Performs a drill-down for the required element asynchronously. |
Reload |
Reloads data in the data sources. |
Reload |
Reloads data in the data sources. |
Reload |
Reloads data from the data source for the specified dashboard item. |
Reload |
Reloads data in the data sources asynchronously. |
Reload |
Reloads data from the data source for the specified dashboard item asynchronously. |
Reload |
Reloads data in the data sources asynchronously. |
Reload |
Reloads data from the specified data source instance. |
Reload |
Reloads data from the specified data source. Accepts data source component name as the parameter. |
Reload |
Reloads data from the specified data source instance. The operation is asynchronous. You can propagate a notification to cancel it. |
Reload |
Reloads data from the specified data source. Accepts data source object as the parameter. The operation is asynchronous. |
Reload |
Reloads data from the specified data source. Accepts data source component name as the parameter. The operation is asynchronous. You can propagate a notification to cancel it. |
Reload |
Reloads data from the specified data source. Accepts data source component name as the parameter. The operation is asynchronous. |
Restore |
Restores the item size if an item is expanded to the entire dashboard size (maximized). |
Restore |
Restores the item size if an item is expanded to the entire dashboard size (maximized) in an asynchronous task. |
Save |
Saves a dashboard layout (layout items and layout containers) to a stream. |
Save |
Saves a dashboard layout to a separate XML file. |
Set |
Applies the dashboard state to the loaded dashboard. |
Set |
Applies the dashboard state to the dashboard, asynchronously. |
Set |
Applies the dashboard state to the dashboard, asynchronously. |
Set |
Selects required elements in the specified master filter item. |
Set |
Selects required elements in the specified master filter item. |
Set |
Selects required elements in the specified master filter item. |
Set |
Selects the elements by their values in the specified master filter item. |
Set |
Selects the specified elements in the specified master filter item. |
Set |
Selects the specified elements in the specified master filter item. |
Set |
Selects the specified elements in the specified master filter item. |
Set |
Selects the specified elements in the specified master filter item. |
Set |
Selects the specified elements in the specified master filter item. |
Set |
Selects the specified elements in the specified master filter item. |
Set |
Selects the specified elements in the specified master filter item. |
Set |
Selects the specified elements in the specified master filter item. |
Set |
Selects the required range in the specified Range Filter or Date Filter dashboard item. |
Set |
Selects the specified range in the specified Range Filter or Date Filter dashboard item. |
Set |
Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously. |
Set |
Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously. |
Set |
Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously. |
Set |
Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously. |
Set |
Selects the tab page specified by its index in the specified tab container. |
Set |
Selects the specified tab page. |
Show |
Invokes the Dashboard Parameters dialog in the Dashboard |
Show |
Invokes the Data Inspector dialog with a defined data type for the specified dashboard item. |
Show |
Invokes the Data Inspector dialog for the specified dashboard item. |
Show |
Invokes the Data Inspector dialog with a defined data type for the specified dashboard item asynchronously. |
Show |
Invokes the Data Inspector dialog for the specified dashboard item asynchronously. |
Show |
Invokes the dialog that allows end-users to export the entire dashboard to the specified format. |
Show |
Invokes the dialog that allows end-users to export the dashboard item to the specified format. |
Show |
Invokes the Print Preview, which shows the print preview of the dashboard. |
Show |
Invokes the Print Preview window for the specified dashboard item. |
Show |
Invokes the Ribbon Print Preview Form, which shows the print preview of the dashboard. |
Show |
Invokes the Ribbon Print Preview window for the specified dashboard item. |
Update |
Fires the Dashboard |
Update |
Fires the Dashboard |
Update |
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. |
Update |
Updates all extract data sources in the current dashboard asynchronously. Allows you to specify custom actions to perform after updating the data and file. |
#Events
Name | Description |
---|---|
Async |
Allows you to provide data for the Dashboard |
Async |
Allows you to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files asynchronously. |
Async |
Allows you to validate a custom SQL query of the Dashboard |
Before |
Allows you to hide specific dashboard items when printing or exporting the entire dashboard. |
Configure |
Allows you to customize connection settings before the Dashboard |
Connection |
Allows to override the default behavior if data store connection fails with current connection parameters. |
Custom |
Occurs before a custom assembly is loaded for use as Dashboard |
Custom |
Occurs when a dashboard control visualizes a custom item. |
Custom |
Allows you to customize the exported document. |
Custom |
Allows you to include WHERE clauses into Dashboard |
Customize |
Allows you to customize the dashboard item caption at runtime. |
Customize |
Allows you to customize the dashboard title at runtime. |
Customize |
Allows you to customize the exported document. |
Custom |
Allows you to substitute the default palette containing colors used to paint dashboard item elements. |
Custom |
Occurs before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing. |
Dashboard |
Occurs after a dashboard has been opened. |
Dashboard |
Occurs when the custom property value in the Dashboard Viewer / Dashboard Designer is changed. |
Dashboard |
Allows you to access underlying Win |
Dashboard |
Occurs when an end user clicks a dashboard item. |
Dashboard |
Allows you to access underlying Win |
Dashboard |
Allows you to access underlying Win |
Dashboard |
Occurs when an end user double-clicks a dashboard item. |
Dashboard |
Allows you to color the required dashboard item elements using the specified colors. |
Dashboard |
Fires when an item becomes maximized or restores its original size. |
Dashboard |
Occurs when the mouse pointer is over the dashboard item and a mouse button is pressed. |
Dashboard |
Occurs when the mouse pointer enters the dashboard item. |
Dashboard |
Occurs when the mouse pointer rests on the dashboard item. |
Dashboard |
Occurs when the mouse pointer leaves the dashboard item. |
Dashboard |
Occurs when the mouse pointer is moved over the dashboard item. |
Dashboard |
Occurs when the mouse pointer is over the dashboard item and a mouse button is released. |
Dashboard |
Occurs when the mouse wheel moves while the dashboard item has focus. |
Dashboard |
Occurs after the selection within the dashboard item is changed. |
Dashboard |
Allows you to provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting. |
Dashboard |
Occurs after the dashboard is loaded to the Dashboard |
Dashboard |
Occurs after the current dashboard state in the Dashboard |
Data |
Occurs before the Data Inspector window closes. Allows you to access the window’s grid controls. |
Data |
Occurs before the Data Inspector window displays. Allows you to access the window’s grid controls and change their settings. |
Data |
Allows you to provide data for the Dashboard |
Data |
Allows you to suppress the form containing errors that occur during data loading. |
Drill |
Occurs after drill-down is performed. |
Drill |
Occurs after a drill-up is performed. |
Export |
Occurs when the Export Form is about to be displayed, and allows you to cancel the action. |
Initialized | Handle this event to get the dashboard item data, and apply master filter and dashboard state in asynchronous mode. |
Layout |
Occurs after the dashboard layout is changed. |
Master |
Occurs when an end user clears the selection in the master filter item. |
Master |
Allows you to apply default filtering to master filter items. |
Master |
Occurs when an end user changes the state of the master filter. |
Popup |
Allows you to customize the pop-up menu that users invoke in the dashboard control. |
Print |
Allows you to customize the Print Preview window at runtime. |
Range |
Allows you to specify the default selected range in the Range Filter dashboard item. |
Selected |
Occurs when the selected tab page is changed. |
Set |
Allows you to specify the initial dashboard state when loading a dashboard. |
Validate |
Allows you to validate a custom SQL query of the Dashboard |
See Also