DataPA Enterprise Dashboard Controls API Reference

The DashboardDesigner type exposes the following members.

Constructors

  Name Description
Public method DashboardDesigner
"Creates and returns a new Dashboard object"

Methods

  Name Description
Public method AddDashboardObject
Adds a new DashboardObject to the current tab.
Public method AddDashboardObjectsContextMenu
Builds and returns a context menu with items for each Dashboard Object.
Public method AddNewTab
Adds a new DashboardTab object to the current ManagedDashboard object.
Public method AllPagesFromObject
Returns a collection containing all page objects referenced by a DashboardObject.
Public method AutoRefreshOnClient
Gets a value that indicates if dashboards should autorefresh on the client.
Public method CancelRefreshQuery
Public method CheckForUpdates
Checks for any available updates.
Public method CloseDashboard
Closes the currently open ManagedDashboard object. If force TRUE, the user will not be prompted to save any changes.
Public method CopyDashboardObject
Copies to the clipboard the Dashboard object.
Public method CreateDashboard
Create a new ManagedDashboard object and opens it in the control.
Public method CreateQuery
Creates a new query in the current ManagedDashboard object.
Public method CutDashboardObject
Copies to the clipboard and deletes the Dashboard object.
Public method DashboardObjectFromID
Returns a DashboardObject object referenced by a given ID.
Public method DashboardObjectPageFromID
Returns a containing page object referenced by a DashboardObject ID.
Public method DashboardObjectPageFromObject
Returns a containing page object referenced by a DashboardObject.
Public method DashboardPageFromID
Returns a containing page object referenced by a Tab ID.
Public method DashboardTabPageFromID
Returns a containing page object referenced by a Tab ID.
Public method DashboardWorkspaceFromID
Returns a containing Workspace object referenced by a Tab ID.
Public method DashboardWorkspaceFromPage
Returns a tab workspace object from the contained page.
Public method DeleteDashboardObject
Deletes the Dashboard object.
Public method DeleteQuery
Deletes the query specified by ID. If ID is not specified (or is a blank string), the query specified by SelectedQuery is modified
Public method DeleteSelectedTab
Deletes the current selected DashboardTab objects.
Protected method Dispose
Releases the unmanaged resources used by the DashboardDesigner and optionally releases the managed resources
(Overrides ContainerControl..::..Dispose(Boolean).)
Public method EditDashboardObject
Opens the object definition dialog box for the Dashboard object.
Protected method Finalize (Overrides Component..::..Finalize()()()().)
Public method GetDataViewerDisplayLayout
Gets the layout of a specific data viewer as an XML string.
Public method GetDataViewerKeys
Gets a collection that contains the key of each available data viewer in the dashboard.
Public method GetDockingLayout
Gets the current docking layout to and from an XML string.
Public method GetTabLayout
Gets the layout of a specific tab in the form of an XML document string.
Public method ImportDashboard
Imports a dashboard and adds it to an existing open dashbpoard.
Public method Initialise
Method that needs to be called before the control can be used.
Public method 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.).
Public method LoadDashboardLayout
Applies the layout stored in the tabs LayoutXML property to the display.
Public method ManageSchedule
Shows the DataPA ManageSchedule dialog.
Public method ModifyQuery
Modifies the query specified by ID. If ID is not specified (or is a blank string), the query specified by SelectedQuery is modified.
Public method 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.
Protected method OnKeyDown (Overrides Control..::..OnKeyDown(KeyEventArgs).)
Public method OpenDashboard
Opens a ManagedDashboard object from disk.
Public method OpenDashboardDelayedRender
Opens a ManagedDashboard object from disk and delays the rendering of the dashboard until after a query is refreshed.
Public method OpenDashboardErrorHandled
Opens a ManagedDashboard object from disk, allowing override of default error handling.
Public method OpenDashboardFromByteArray
Opens a ManagedDashboard object from byte array.
Public method OpenDashboardFromService(String%)
Shows the dialog to allow the user to open a ManagedDashboard object from a DataPA Enterprise Service.
Public method OpenDashboardFromService(String, String%)
Opens a ManagedDashboard object from a DataPA Enterprise Service.
Public method PasteDashboardObject
Creates a new DashboardObject in the DashboardTab specified by SelectedTab using the contents of the clipboard.
Public method Print
Prints the current ManagedDashboard object
Public method PrintPreview
Opens the print preview dialog for the current ManagedDashboard object.
Public method PrintSetup
Opens the print setup dialog for the current ManagedDashboard object.
Protected method ProcessKeyPreview
Trap any keypress before child controls get hold of them
(Overrides Control..::..ProcessKeyPreview(Message%).)
Public method PublishDashboard
Publishes the current Dashboard to a remote DataPA Enterprise Server.
Public method RebuildDisplay
Rebuilds the display.
Public method Refresh (Overrides Control..::..Refresh()()()().)
Public method RefreshAllObjects
Forces a redraw of all the Dashboard objects.
Public method RefreshObject
Forces a redraw of the given Dashboard object.
Public method RefreshQueries
Refreshes all the querys.
Public method RefreshQuery
Refreshes the query specified by ID. If ID is not specified (or is a blank string), the query specified by SelectedQuery is modified.
Public method RestoreDockingDefaults
Restores the window docking to the default configuration.
Public method SaveDashboard
Saves the current managedDashboard object to disk.
Public method SaveDashboardLayout
Updates the Tab.LayouXML property from the currently displayed layout.
Public method SelectedTabWorkspace
Gets the workspace container of the currently selected DashboardTab.
Public method SelectTab
Selects the DashboardTab object specified by Index.
Public method SetAutoRefreshOnClient
Method to set a value that indicates if dashboards should autorefresh on the client.
Public method SetDataViewerDisplayLayout
Applies an XML layout string to a specific data viewer.
Public method SetDockingLayout
Sets the docking layout from an XML string.
Public method SetTabLayout
Sets the layout of a specific tab using an XML document string.
Public method ShareQuery
Shares the query specified by ID. If ID is not specified (or is a blank string), the query specified by SelectedQuery is modified
Public method ShowAbout
Shows the About window.
Public method ShowCalculatedColumns
Shows the calculated columns dialog.
Public method ShowDashboardObjectHTML
Opens a window showing the HTML source for the Dashboard object.
Public method ShowDataManagement
Shows the Data Management dialog
Public method ShowEditTabTitle
Displays the Edit Tab Title dialog box to allow the tab title to be edited.
Public method ShowHelp
Shows the help file.
Public method ShowHideWindow
Allows specific docking windows to be shown and hidden.
Public method ShowLastRunDetails
Shows the details of the last run of a query.
Public method ShowManagePublished
Shows the Manage Published dialog.
Public method ShowProperties
Public method ShowRegister
Shows the DataPA License dialog.
Public method ShowSecurity
Shows the DataPA Security dialog.
Public method ShowSelectConnection
Shows the DataPA SelectConnection dialog.
Public method ShowSetup
Shows the DataPA Setup dialog.
Public method TabWorkspaceFromPage
Returns a containing workspace object referenced by contained page.
Protected method WndProc (Overrides UserControl..::..WndProc(Message%).)

Properties

  Name Description
Public property AboutMenuItemLabel
Gets and sets the label of the about menu item on the context menu of charts.
Public property AboutMenuItemLink
Gets and sets the link of the about menu item on the context menu of charts.
Public property AllowManageConnections
Public property AllowTabDesignModeWhenViewerOnly
Gets and sets a value that indicates if the interface allows the user to re-arange objects in the tab when in viewer only mode.
Public property BackgroundColor
Public property BackgroundImage (Overrides Control..::..BackgroundImage.)
Public property ClipboardContainsDashboardObject
Gets a value that indicates whether the clipboard contains valid data to support the PasteDashboardObject method.
Public property Dashboard
Gets the current ManagedDashboard object.
Public property DataPAApplication
The DataPA Application Object used to provide the core DataPA data functionality. If this property has not been assigned a valid DataPA Application object before the initialise method is called, the control will create its own instance of the DataPA Application Object.
Public property DataViewerPages
Gets an array of the currently available DataViewer pages.
Public property DebugLogging
Gets and sets a value that indicates whether debug logging is enabled.
Public property DelayedRender
Gets a value that indicates if the rendering of the open dashboard has been delayed.
Public property Enabled
Public property FloatingWindowEnvironment
Gets a value that indicates if the current environment supports floating docking windows.
Public property FontListItems
Gets a collection of List Items containing a visual list of available fonts.
Public property ForegroundColor
Public property FullScreenMode
Gets and sets a value that indicates if the control is in full screen mode.
Public property HasDashboard
Gets a value that indicates if the control has an open ManagedDashboard object.
Public property HasData
Gets a value that indicates if the ManagedDashboard object in the control has any data that can be used to build Dashboard Objects.
Public property HasObjects
Gets a value that indicates if the ManagedDashboard object in the control has one or more DashboardObject objects
Public property HasQueries
Gets a value that indicates if the ManagedDashboard object in the control has one or more DashboardQuery objects.
Public property HasTabs
Gets a value that indicates if the ManagedDashboard object in the control has one or more DashboardTab objects.
Public property Initialised
Gets a property indicating whether or not the Initialise method has been called. The control cannot be used while this value is false.
Public property IsPublishingDashboard
Public property NavigatorContextButtonCollection
Gets the Button Collection on the Navigator to allow the developer to add their own buttons.
Public property PaletteMode
Gets or sets palette style that is applied to the dashboard control to change its and any child forms appearance.
Public property PauseAutoRefresh
Gets and sets a property that indicates if the autorefresh of queries should be pause.
Public property PreparingPrint
Gets a property that indicates if the control is currently processing the prepare print operation.
Public property PublishServer
Gets and sets the Server URL for DataPA Enterprise
Public property QuerySelected
Gets a value that indicates if SelectedQuery will return a valid Dashboard Query object.
Public property RefreshingQuery
Gets the DashboardQuery object that represents the current refreshing query.
Public property RunDataPAApplication
The RunDataPA Application Object used to provide the core DataPA data functionality. If this property has not been assigned a valid RunDataPA Application object before the initialise method is called, the control will create its own instance of the DataPA Application Object.
Public property SavedLoginDetails
Gets and sets a collection that contains a username and password that will be used as the default properties to connect to a server.
Public property SelectedObject
Gets a DashboardObject object that is the currently selected dashboard object. If none are selected, returns nothing.
Public property SelectedQuery
Gets a DashboardQuery object that is the currently selected dashboard query. If none are selected, returns nothing.
Public property SelectedTab
Gets a DashboardTab object that is the currently selected dashboard tab. If none are selected, returns nothing.
Public property SelectedTabIndex
Gets index of the currently selected dashboard tab. If none are selected, returns -1.
Public property ShowAboutMenuItem
Gets and sets a value that indicates whether the about menu item will appear on the context menu of charts.
Public property ShowCopyQuery
Gets and sets a property that indicates if the Copy an existing query step is shown in the query wizard.
Public property ShowDataViewersWhenViewerOnly
Gets and sets a value that determines if the Dashboard will show the query data viewers when ViewerOnly is true.
Public property ShowTabs
Gets and sets a value that indicates whether the tabs are shown in the dashboard viewer.
Public property StatusStripVisible
Gets and sets a value indicating whether the status strip is visible at the bottom of the control.
Public property ViewerOnly
If set to True, the Dashboard control will act as a viewer only, disabling and preventing the display of any controls associated with editing a dashboard.
Public property Visible

Events

  Name Description
Public event AfterDashboardPublish
Event raised after a dashboard publish process has completed.
Public event AfterDrillDown
Event raised when a drill down link is clicked on a dashboard object, after the drill down is processed.
Public event AfterHyperlink
Event raised when a Hyperlink is clicked on a dashboard object, after the hyperlink is processed.
Public event AfterPreparePrint
Event raised when the control completes the prepare print operation.
Public event ApplyingDataGridLayout
Event raised before the control applies a layout to a data grid dashboard object.
Public event ApplyingDataViewerLayout
Event raised before the control applies a layout to a data viewer.
Public event AvailableCommandsChanged
Event raised when an action changes the available operations. This event is useful for enabling and disabling the containers controls to reflect which operations can and cannot be performed.
Public event BeforeBuildObject
Event raised before the control builds each object on the dashboard.
Public event BeforeDashboardPublish
Event raised before the current dashboard is published.
Public event BeforeDrillDown
Event raised when a drill down link is clicked on a dashboard object, before the drill down is processed. Setting the DrillDownEventArgs.Cancel property to true in the handler for this event will prevent the drill down from processing.
Public event BeforeFileDialog
Event raised before showing the file dialog.
Public event BeforeHyperlink
Event raised when a hyperlink is clicked on a dashboard object, before the hyperlink is processed. Setting the HyperlinkEventArgs.Cancel property to true in the handler for this event will prevent the hyperlink from processing.
Public event BeforePreparePrint
Event raised when the control begins the prepare print operation.
Public event Click
Public event DashboardClosed
Event raised when a ManagedDashboard object is closed by the control.
Public event DashboardOpened
Event raised when a ManagedDashboard object is opened by the control.
Public event DashboardRendered
Event raised when the control renders a dashboard
Public event DblClick
Public event DoubleClickDashboardObject
Event raised before a double click event is processed on a dashboard object.
Public event PreProcessKeyDown
Event raised before a key down event is processed by the control.
Public event ProcessDataRequest
Event raised when the user selects the process button on a drill down data grid.
Public event RequiredFieldValueRequest
Event raised for each Required Field that is not assigned a valid ControlPanelObject, before the query is run.
Public event SelectedQueryChanged
Event raised when the SelectedQuery property changes.
Public event SelectedTabChanged
Event raised when the SelectedTab property changes.
Public event TabsModified
Event raised when a dashboard tab is added, deleted or has its title changed, or when the order of the tabs is changed.

See Also