| DashboardDesigner Methods |
|
The DashboardDesigner type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
AddDashboardObject |
Adds a new DashboardObject to the current tab.
|
|
|
AddDashboardObjectsContextMenu |
Builds and returns a context menu with items for each Dashboard Object.
|
|
|
AddNewTab |
Adds a new DashboardTab object to the current ManagedDashboard object.
|
|
|
AllPagesFromObject |
Returns a collection containing all page objects referenced by a DashboardObject.
|
|
|
AutoRefreshOnClient |
Gets a value that indicates if dashboards should autorefresh on the client.
|
|
|
CancelRefreshQuery | |
|
|
CheckForUpdates |
Checks for any available updates.
|
|
|
CloseDashboard |
Closes the currently open ManagedDashboard object. If force TRUE, the user will not be prompted to save any changes.
|
|
|
CopyDashboardObject(String) |
Copies to the clipboard the Dashboard object.
|
|
|
CopyDashboardObject(DashboardObject) |
Copies to the clipboard the Dashboard object.
|
|
|
CopyDashboardTab(String) |
Copies to the clipboard the Dashboard tab.
|
|
|
CopyDashboardTab(DashboardTab) |
Copies to the clipboard the Dashboard tab.
|
|
|
CreateDashboard |
Create a new ManagedDashboard object and opens it in the control.
|
|
|
CreateQuery |
Creates a new query in the current ManagedDashboard object.
|
|
|
CutDashboardObject |
Copies to the clipboard and deletes the Dashboard object.
|
|
|
CutDashboardTab |
Copies to the clipboard and deletes the Dashboard tab.
|
|
|
DashboardObjectControlFromID |
Returns the control that renders a dashboard object in the dashboard
|
|
|
DashboardObjectFromID |
Returns a DashboardObject object referenced by a given ID.
|
|
|
DashboardObjectPageFromID |
Returns a containing page object referenced by a DashboardObject ID.
|
|
|
DashboardObjectPageFromObject |
Returns a containing page object referenced by a DashboardObject.
|
|
|
DashboardPageFromID |
Returns a containing page object referenced by a Tab ID.
|
|
|
DashboardTabPageFromID |
Returns a containing page object referenced by a Tab ID.
|
|
|
DashboardWorkspaceFromID |
Returns a containing Workspace object referenced by a Tab ID.
|
|
|
DashboardWorkspaceFromPage |
Returns a tab workspace object from the contained page.
|
|
|
DeleteDashboardObject |
Deletes the Dashboard object.
|
|
|
DeleteQuery |
Deletes the query specified by ID. If ID is not specified (or is a blank string), the query specified by SelectedQuery is modified
|
|
|
DeleteSelectedTab |
Deletes the current selected DashboardTab objects.
|
|
|
EditDashboardObject |
Opens the object definition dialog box for the Dashboard object.
|
|
|
GetDataViewerDisplayLayout |
Gets the layout of a specific data viewer as an XML string.
|
|
|
GetDataViewerKeys |
Gets a collection that contains the key of each available data viewer in the dashboard.
|
|
|
GetDockingLayout |
Gets the current docking layout to and from an XML string.
|
|
|
GetTabLayout |
Gets the layout of a specific tab in the form of an XML document string.
|
|
|
HideDataViewers |
Removes all the source data dataviewers from the display
|
|
|
ImportDashboard |
Imports a dashboard and adds it to an existing open dashbpoard.
|
|
|
Initialise |
Method that needs to be called before the control can be used.
|
|
|
IsPageShowing |
Gets or sets a value indicating whether the docking page specified by PageType and Index is visible. (Index is only applicable if the PageType is DashboardPageType.DataViewer, and refers to the index of the specific DataViewer page in the DataViewerPages array.).
|
|
|
LoadDashboardLayout |
Applies the layout stored in the tabs LayoutXML property to the display.
|
|
|
ManageSchedule |
Shows the DataPA ManageSchedule dialog.
|
|
|
ModifyQuery |
Modifies the query specified by ID. If ID is not specified (or is a blank string), the query specified by SelectedQuery is modified.
|
|
|
OKToClose |
If the control contains a ManagedDashboard object with unsaved changes, will prompt the user to save the changes. returns False if the user selects cancel.
|
|
|
OpenDashboard |
Opens a ManagedDashboard object from disk.
|
|
|
OpenDashboardDelayedRender |
Opens a ManagedDashboard object from disk and delays the rendering of the dashboard until after a query is refreshed.
|
|
|
OpenDashboardErrorHandled |
Opens a ManagedDashboard object from disk, allowing override of default error handling.
|
|
|
OpenDashboardFromByteArray |
Opens a ManagedDashboard object from byte array.
|
|
|
OpenDashboardFromService(String) |
Shows the dialog to allow the user to open a ManagedDashboard object from a DataPA Enterprise Service.
|
|
|
OpenDashboardFromService(String, String) |
Opens a ManagedDashboard object from a DataPA Enterprise Service.
|
|
|
PasteDashboardObject |
Creates a new DashboardObject in the DashboardTab specified by SelectedTab using the contents of the clipboard.
|
|
|
PasteDashboardTab |
Creates a new DashboardTab in the dashboard using the contents of the clipboard.
|
|
|
Prints the current ManagedDashboard object
|
|
|
|
PrintPreview |
Opens the print preview dialog for the current ManagedDashboard object.
|
|
|
PrintSetup |
Opens the print setup dialog for the current ManagedDashboard object.
|
|
|
PublishDashboard |
Publishes the current Dashboard to a remote DataPA Enterprise Server.
|
|
|
RebuildDisplay |
Rebuilds the display.
|
|
|
Refresh | (Overrides ControlRefresh.) |
|
|
RefreshAllObjects |
Forces a redraw of all the Dashboard objects.
|
|
|
RefreshObject |
Forces a redraw of the given Dashboard object.
|
|
|
RefreshQueries |
Refreshes all the querys.
|
|
|
RefreshQuery |
Refreshes the query specified by ID. If ID is not specified (or is a blank string), the query specified by SelectedQuery is modified.
|
|
|
RestoreDockingDefaults |
Restores the window docking to the default configuration.
|
|
|
SaveDashboard |
Saves the current managedDashboard object to disk.
|
|
|
SaveDashboardLayout |
Updates the Tab.LayouXML property from the currently displayed layout.
|
|
|
SelectedTabWorkspace |
Gets the workspace container of the currently selected DashboardTab.
|
|
|
SelectTab |
Selects the DashboardTab object specified by Index.
|
|
|
SetAutoRefreshOnClient |
Method to set a value that indicates if dashboards should autorefresh on the client.
|
|
|
SetDataViewerDisplayLayout |
Applies an XML layout string to a specific data viewer.
|
|
|
SetDockingLayout |
Sets the docking layout from an XML string.
|
|
|
SetTabLayout |
Sets the layout of a specific tab using an XML document string.
|
|
|
ShareQuery |
Shares the query specified by ID. If ID is not specified (or is a blank string), the query specified by SelectedQuery is modified
|
|
|
ShowAbout |
Shows the About window.
|
|
|
ShowCachedAddresses |
Shows the cached addresses dialog
|
|
|
ShowCalculatedColumns |
Shows the calculated columns dialog.
|
|
|
ShowDashboardObjectHTML |
Opens a window showing the HTML source for the Dashboard object.
|
|
|
ShowDataManagement |
Shows the Data Management dialog
|
|
|
ShowEditTabTitle |
Displays the Edit Tab Title dialog box to allow the tab title to be edited.
|
|
|
ShowHelp |
Shows the help file.
|
|
|
ShowHideWindow |
Allows specific docking windows to be shown and hidden.
|
|
|
ShowLastRunDetails |
Shows the details of the last run of a query.
|
|
|
ShowManagePublished |
Shows the Manage Published dialog.
|
|
|
ShowProperties |
Shows the properties dialog
|
|
|
ShowRegister |
Shows the DataPA License dialog.
|
|
|
ShowSecurity |
Shows the DataPA Security dialog.
|
|
|
ShowSelectConnection |
Shows the DataPA SelectConnection dialog.
|
|
|
ShowSetup |
Shows the DataPA Setup dialog.
|
|
|
TabWorkspaceFromPage |
Returns a containing workspace object referenced by contained page.
|
See Also