DataPA Enterprise Dashboard Controls API Reference 
        
        
          
            
        
          
            
        
        
          
            
        
          
            
        
        
          
            
        
          
            
        
        
          
            
        
          
            
        
        
          
            
        
      
      
    The ManagedDashboard type exposes the following members.
          
            
Constructors
        
        | Name | Description | |
|---|---|---|
| 
                 | 
              ManagedDashboard()()()() | 
                 
 Create and returns a new Manageddashboard object
  
               | 
            
| 
                 | 
              ManagedDashboard(Application) | 
                 
 Create and returns a new Manageddashboard object.
  
               | 
            
| 
                 | 
              ManagedDashboard(SerializationInfo, StreamingContext) | 
                 Initializes a new instance of the ManagedDashboard class 
               | 
            
          
            
Methods
        
        | Name | Description | |
|---|---|---|
| 
                 | 
              AddQueryFromFile | 
                 
 Allows a query to be added to the dashboard from a query file.
  
               | 
            
| 
                 | 
              CancelRefreshingQuery | 
                 
 Causes the RefreshingQuery to be cancelled.
  
               | 
            
| 
                 | 
              Finalize | (Overrides Object..::..Finalize()()()().) | 
| 
                 | 
              GetObjectData(SerializationInfo) | |
| 
                 | 
              GetObjectData(SerializationInfo, StreamingContext) | |
| 
                 | 
              KillTimers | 
                 
 Stops all auto refresh timers.
  
               | 
            
| 
                 | 
              ProcessAlerts()()()() | 
                 
 Method that checks the conditions against each defined dashboard alert and raises the Alert event for any that resolve to true
  
               | 
            
| 
                 | 
              ProcessAlerts(DashboardQuery) | 
                 
 Method that checks the conditions against each dashboard alert based on a specific query and raises the Alert event for any that resolve to true
  
               | 
            
| 
                 | 
              ProcessPostRefreshData | |
| 
                 | 
              Publish | 
                 
 Publishes this Dashboard to DataPA Enterprise
  
               | 
            
| 
                 | 
              RefreshDataAndSave | 
                 
 Refreshes all the data in the dashboard and saves the resulting dashboard. 
  
               | 
            
| 
                 | 
              RefreshXML | 
                 
 Causes all DashboardObjects in this ManagedDashboard to rebuild the XML property.
  
               | 
            
| 
                 | 
              Save | 
                 
 Saves this dashboard to disk.
  
               | 
            
| 
                 | 
              Serialize | 
                 
 Serializes this ManagedDashboard to a memory stream
  
               | 
            
| 
                 | 
              SetObjectData | |
| 
                 | 
              UpdateDashboardObjectsAfterQueryRefresh | 
                 
 Updates all of the dashboard objects dependant on a specific query
  
               | 
            
          
            
Properties
        
        | Name | Description | |
|---|---|---|
| 
                 | 
              Application | 
                 
 Gets and sets the RunDataPA Application Object used to provide the core DataPA data functionality for this object.
  
               | 
            
| 
                 | 
              Author | 
                 
 Gets and sets the author of this dashboard.
  
               | 
            
| 
                 | 
              AutoRefreshFunction | 
                 
 Gets the Javascript required to support auto refresh functionality in the web for this ManagedDashboard.
  
               | 
            
| 
                 | 
              BuildIndependantObjectHTML | 
                 
 Gets and sets a value that indicates if the HTML for each dashboard object should be rendered as a single document.
  
               | 
            
| 
                 | 
              BuildPartialSummaries | |
| 
                 | 
              Category | 
                 
 Gets and sets a category used to identify of this dashboard.
  
               | 
            
| 
                 | 
              chartBaseFontSize | 
                 
 Gets and sets the base font size of the chart.
  
               | 
            
| 
                 | 
              chartOutCnvBaseFontSize | 
                 
 Gets and sets the base font size for labels outside the chart canvas bounds.
  
               | 
            
| 
                 | 
              ChartSupportScript | 
                 
 Gets the Javascript required to support web rendering of this ManagedDashboard.
  
               | 
            
| 
                 | 
              Clone | 
                 
 Gets cloned copy of this dashboard.
  
               | 
            
| 
                 | 
              Comments | 
                 
 Gets and sets a comments string associated with this dashboard.
  
               | 
            
| 
                 | 
              ControlPanelObjectFromID | 
                 
 Gets a ControlPanelObject from a given ID.
  
               | 
            
| 
                 | 
              CurrentAlerts | 
                 
 Gets a list of the current alerts
  
               | 
            
| 
                 | 
              DashboardClientType | 
                 
 Gets and sets a the client type for which this dashboard should be rendered
  
               | 
            
| 
                 | 
              DashboardContainsAnyFilters | 
                 
 Gets a boolean flag that indicate whether the dashboard has any filters anywhere on it.
  
               | 
            
| 
                 | 
              DashboardObjectFromID | 
                 
 Gets a Dashboard Object by searching all DashboardObjects in this ManagedDashboards tabs for the given ID.
  
               | 
            
| 
                 | 
              DebugQueries | 
                 
 Gets and sets a value that indicates if this dashboard will generate query debug information.
  
               | 
            
| 
                 | 
              Description | 
                 
 Gets and sets the description of this dashboard.
  
               | 
            
| 
                 | 
              DPALogging | 
                 
 Gets and sets the logging object for this managed dashboard instance.
  
               | 
            
| 
                 | 
              DrillDownFunction | 
                 
 Gets the Javascript required to support drill downs in the web for this ManagedDashboard.
  
               | 
            
| 
                 | 
              FileName | 
                 
 Gets and sets the file name for this dashboard.
  
               | 
            
| 
                 | 
              FilterParamaterObjects | 
                 
 Gets a collection that contains all of the ControlPanelObjects with an objectType property of ControlPanelObjectFilterParameter.
  
               | 
            
| 
                 | 
              GUID | 
                 
 Gets and sets a GUID that uniquely identifies this object.
  
               | 
            
| 
                 | 
              HasData | 
                 
 Gets a value that indicates if this dashboard has data.
  
               | 
            
| 
                 | 
              Height | 
                 
 Gets the height of this Dashboard.
  
               | 
            
| 
                 | 
              HttpApplicationPath | 
                 
 Gets and sets the the ApplicationPath for this Managed Dashboard.
  
               | 
            
| 
                 | 
              ID | 
                 
 Gets a value that indicates the Unique ID of this object.
  
               | 
            
| 
                 | 
              InLineXML | 
                 
 Gets and sets a property that indicates if the XML for charts should be renderedd in line with the HTML.
  
               | 
            
| 
                 | 
              KeyWords | 
                 
 Gets and sets a commer seperated list of keywords used to identify this dashboard.
  
               | 
            
| 
                 | 
              LogObjectErrors | 
                 
 Gets and sets a value that indicates if this dashboard will log object errors.
  
               | 
            
| 
                 | 
              Modified | 
                 
 Gets and sets a value that indicates if this dashboard has been modified since the last save.
  
               | 
            
| 
                 | 
              PageSettings | 
                 
 Gets and sets the page settings object for this dashboard.
  
               | 
            
| 
                 | 
              PrintScalePercent | 
                 
 Gets and sets a value that indicates the scaling used to print this dashboard.
  
               | 
            
| 
                 | 
              Queries | 
                 
 Gets or sets the DashboardQueries object for this Dashboard.
  
               | 
            
| 
                 | 
              RaisedAlerts | |
| 
                 | 
              RefreshAndSaveCompletedOK | 
                 
 Gets and sets an error flag used by RefreshAndSave
  
               | 
            
| 
                 | 
              RefreshAndSaveErrorString | 
                 
 Gets and sets an error string used by RefreshAndSave
  
               | 
            
| 
                 | 
              RefreshingQuery | 
                 
 Gets the DashboardQuery object that represents the current refreshing query.
  
               | 
            
| 
                 | 
              SaveDataFailed | 
                 
 Gets a property that indicates if one or more queries failed to serialize the data during the last serialzation process.
  
               | 
            
| 
                 | 
              SaveDataFailedQueries | 
                 
 Gets a list of queries that failed to serialize the data during the last serialzation process.
  
               | 
            
| 
                 | 
              SelectedTab | 
                 
 Gets and sets the currently selected DashboardTab
  
               | 
            
| 
                 | 
              ServerFileName | 
                 
 Gets and sets the filename of this dashboard on the server
  
               | 
            
| 
                 | 
              ShowDebugInfo | 
                 
 Gets and sets a value that indicates if this dashboard will show debug information.
  
               | 
            
| 
                 | 
              Silent | 
                 
 Gets and sets a property that indicates if error messages should be supressed
  
               | 
            
| 
                 | 
              Skin | 
                 
 Gets and sets the DashboardSkin object that defines the appearance of this dashboard.
  
               | 
            
| 
                 | 
              Tabs | 
                 
 Gets or sets the DashboardTabs object for this Dashboard.
  
               | 
            
| 
                 | 
              Title | 
                 
 Gets and sets the title of this dashboard.
  
               | 
            
| 
                 | 
              ToArray | 
                 
 Gets this object converted to a byte array.
  
               | 
            
| 
                 | 
              UserGroup | 
                 
 Gets and sets the 
  
               | 
            
| 
                 | 
              Username | 
                 
 Gets and sets the current username used to filter content on the dashboard
  
               | 
            
| 
                 | 
              Width | 
                 
 Gets the width of this Dashboard.
  
               | 
            
          
            
Events
        
        | Name | Description | |
|---|---|---|
| 
                 | 
              AfterLoad | 
                 
 Event raised after this ManagedDashboard object is saved to disk.
  
               | 
            
| 
                 | 
              AfterRefreshData | 
                 
 Event raised after this ManagedDashboard object refreshes data.
  
               | 
            
| 
                 | 
              Alert | 
                 
 Event raised for any DashboardAlerts that resolve to true when ProcessAlerts is called.
  
               | 
            
| 
                 | 
              AutoRefreshQueryRequest | 
                 
 Event raised when a dashboard query is due to refresh as determined by its AutoRefresh and RefreshInterval properties.
  
               | 
            
| 
                 | 
              BeforePublish | 
                 
 Event raised before this ManagedDashboard object is published to DataPA Enterprise.
  
               | 
            
| 
                 | 
              BeforeRefreshData | 
                 
 Event raised before this ManagedDashboard object refreshes data.
  
               | 
            
| 
                 | 
              BeforeSave | 
                 
 Event raised before this ManagedDashboard object is saved to disk.
  
               | 
            
| 
                 | 
              DashboardModified | 
                 
 Event raised when this ManagedDashboard object is modified.
  
               | 
            
| 
                 | 
              RequiredFieldValueRequest | 
                 
 Event raised for each Required Field that is not assigned a valid ControlPanelObject, before the query is run.
  
               |