IDashboardControl Methods
Provides API members that are common for DashboardDesigner and DashboardViewer.
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. |
See Also