DashboardDesigner Class

DataPA OpenAnalytics API Reference

Enterprise Dashboard control that exposes functionality to view and edit DataPA Enterprise ManagedDashboard objects.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        System.Windows.FormsScrollableControl
          System.Windows.FormsContainerControl
            System.Windows.FormsUserControl
              DataPAEnterpriseDashboardDashboardDesigner

Namespace: DataPAEnterpriseDashboard
Assembly: DataPAEnterpriseDashboard (in DataPAEnterpriseDashboard.dll) Version: 1.0.90.0 (1.0.90.0)

Syntax

C++

JavaScript

Copy

public class DashboardDesigner : UserControl, 
	_DashboardDesigner

Public Class DashboardDesigner
	Inherits UserControl
	Implements _DashboardDesigner

public ref class DashboardDesigner : public UserControl, 
	_DashboardDesigner

DataPAEnterpriseDashboard.DashboardDesigner = function();

Type.createClass(
	'DataPAEnterpriseDashboard.DashboardDesigner',
	UserControl,
	DataPAEnterpriseDashboard.DashboardDesigner._DashboardDesigner);

The DashboardDesigner type exposes the following members.

Constructors

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

Top

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

Top

Fields

	Name	Description
	ClassId
	EventsId
	InterfaceId

Top

Properties

	Name	Description
	AboutMenuItemLabel	Gets and sets the label of the about menu item on the context menu of charts.
	AboutMenuItemLink	Gets and sets the link of the about menu item on the context menu of charts.
	AllowManageConnections
	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.
	BackgroundColor
	BackgroundImage	(Overrides ControlBackgroundImage.)
	ClientConfig	The ClientConfig Object used to provide the core DataPA client UI functionality.
	ClipboardContainsDashboardObject	Gets a value that indicates whether the clipboard contains valid data to support the PasteDashboardObject method.
	ClipboardContainsDashboardTab	Gets a value that indicates whether the clipboard contains valid data to support the PasteDashboardTab method.
	Dashboard	Gets the current ManagedDashboard object.
	DataViewerPages	Gets an array of the currently available DataViewer pages.
	DebugLogging	Gets and sets a value that indicates whether debug logging is enabled.
	DelayedRender	Gets a value that indicates if the rendering of the open dashboard has been delayed.
	Enabled
	FloatingWindowEnvironment	Gets a value that indicates if the current environment supports floating docking windows.
	FontListItems	Gets a collection of List Items containing a visual list of available fonts.
	ForegroundColor
	FullScreenMode	Gets and sets a value that indicates if the control is in full screen mode.
	HasDashboard	Gets a value that indicates if the control has an open ManagedDashboard object.
	HasData	Gets a value that indicates if the ManagedDashboard object in the control has any data that can be used to build Dashboard Objects.
	HasObjects	Gets a value that indicates if the ManagedDashboard object in the control has one or more DashboardObject objects
	HasQueries	Gets a value that indicates if the ManagedDashboard object in the control has one or more DashboardQuery objects.
	HasTabs	Gets a value that indicates if the ManagedDashboard object in the control has one or more DashboardTab objects.
	Initialised	Gets a property indicating whether or not the Initialise method has been called. The control cannot be used while this value is false.
	IsPublishingDashboard
	NavigatorContextButtonCollection	Gets the Button Collection on the Navigator to allow the developer to add their own buttons.
	PaletteMode	Gets or sets palette style that is applied to the dashboard control to change its and any child forms appearance.
	PauseAutoRefresh	Gets and sets a property that indicates if the autorefresh of queries should be pause.
	PreparingPrint	Gets a property that indicates if the control is currently processing the prepare print operation.
	PublishServer	Gets and sets the Server URL for DataPA Enterprise
	QuerySelected	Gets a value that indicates if SelectedQuery will return a valid Dashboard Query object.
	RefreshingQuery	Gets the DashboardQuery object that represents the current refreshing query.
	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.
	SelectedObject	Gets a DashboardObject object that is the currently selected dashboard object. If none are selected, returns nothing.
	SelectedQuery	Gets a DashboardQuery object that is the currently selected dashboard query. If none are selected, returns nothing.
	SelectedTab	Gets a DashboardTab object that is the currently selected dashboard tab. If none are selected, returns nothing.
	SelectedTabIndex	Gets index of the currently selected dashboard tab. If none are selected, returns -1.
	ShowAboutMenuItem	Gets and sets a value that indicates whether the about menu item will appear on the context menu of charts.
	ShowCopyQuery	Gets and sets a property that indicates if the Copy an existing query step is shown in the query wizard.
	ShowDataViewersWhenViewerOnly	Gets and sets a value that determines if the Dashboard will show the query data viewers when ViewerOnly is true.
	ShowTabs	Gets and sets a value that indicates whether the tabs are shown in the dashboard viewer.
	StatusStripVisible	Gets and sets a value indicating whether the status strip is visible at the bottom of the control.
	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.
	ViewerSourceDataHandling	Gets and sets a value that indicates how the control will manage source data in a dashboard when opened in a viewer only client
	Visible

Top

Events

	Name	Description
	AfterDashboardPublish	Event raised after a dashboard publish process has completed.
	AfterDrillDown	Event raised when a drill down link is clicked on a dashboard object, after the drill down is processed.
	AfterHyperlink	Event raised when a Hyperlink is clicked on a dashboard object, after the hyperlink is processed.
	AfterPreparePrint	Event raised when the control completes the prepare print operation.
	ApplyingDataGridLayout	Event raised before the control applies a layout to a data grid dashboard object.
	ApplyingDataViewerLayout	Event raised before the control applies a layout to a data viewer.
	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.
	BeforeBuildObject	Event raised before the control builds each object on the dashboard.
	BeforeDashboardPublish	Event raised before the current dashboard is published.
	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.
	BeforeFileDialog	Event raised before showing the file dialog.
	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.
	BeforePreparePrint	Event raised when the control begins the prepare print operation.
	Click
	DashboardClosed	Event raised when a ManagedDashboard object is closed by the control.
	DashboardOpened	Event raised when a ManagedDashboard object is opened by the control.
	DashboardRendered	Event raised when the control renders a dashboard
	DblClick
	DoubleClickDashboardObject	Event raised before a double click event is processed on a dashboard object.
	PreProcessKeyDown	Event raised before a key down event is processed by the control.
	ProcessDataRequest	Event raised when the user selects the process button on a drill down data grid.
	RequiredFieldValueRequest	Event raised for each Required Field that is not assigned a valid ControlPanelObject, before the query is run.
	SelectedQueryChanged	Event raised when the SelectedQuery property changes.
	SelectedTabChanged	Event raised when the SelectedTab property changes.
	TabsModified	Event raised when a dashboard tab is added, deleted or has its title changed, or when the order of the tabs is changed.

Top

Remarks

Reference

DataPAEnterpriseDashboard Namespace

Send comments on this topic to info@datapa.com