DataPA Enterprise Dashboard Controls API Reference
The DashboardQuery type exposes the following members.
Constructors
Name | Description | |
---|---|---|
DashboardQuery()()()() |
Creates and returns a new DashboardQuery object.
|
|
DashboardQuery(SerializationInfo, StreamingContext) |
Initializes a new instance of the DashboardQuery class
|
|
DashboardQuery(DashboardQueries, String) |
Creates and returns a new DashboardQuery object.
|
Methods
Name | Description | |
---|---|---|
CancelRefresh |
Cancels a refresh operation for this query.
|
|
ClearRequiredFieldsSuppliedByThirdParty | ||
GetObjectData(SerializationInfo) | ||
GetObjectData(SerializationInfo, StreamingContext) | ||
KillTimer |
Kills any auto refresh timers on this dashboard query
|
|
ReApplyCalculatedColumns |
Rebuilds the values of any calculated columns in this query.
|
|
RefreshData()()()() |
Causes the the query to refresh its data.
|
|
RefreshData(Boolean, Boolean, String, String) |
Causes the the query to refresh its data.
|
|
RequiredFieldsSuppliedByThirdParty | ||
ResolveRequiredFieldRequirements |
Ensures each required field defined by this query has an assoiciated ControlPanelObject on the dashboard.
|
|
SetNextAutoRefresh()()()() |
Sets the next auto refresh for this query.
|
|
SetNextAutoRefresh(DateTime) |
Sets the next auto refresh for this query.
|
|
SetObjectData | ||
UpdateQuery |
Updates the Query object this DashboardQuery is based on.
|
Properties
Name | Description | |
---|---|---|
Alerts | ||
autoRefresh |
Gets and sets a value that indicates whether this query wil refresh automatically.
|
|
CalculatedColumns | ||
ClearDataOnNextRefresh |
Gets and sets a property that indicates if data should be cleared on the next refresh.
|
|
CollateFilter |
Gets and sets a filter that will be applied to the existing data before data from a new refresh is added
|
|
ComRefreshInterval |
Gets and sets a string value that indicates how often the query will auto refresh.
|
|
ConnectionDetails |
Gets and sets a QueryConnectionDetails object that determines how this query handles different connections.
|
|
CurrentNextAutoRefresh |
Gets a value that indicates the current time at which this dashboard query will be refreshed automatically.
|
|
DataManageType |
Gets and sets the data manage type that indicates if this query collates data.
|
|
ErrorsOnLastRefresh |
Gets a property that indicates if the last multi-connection run of this query returned one or more errors.
|
|
ForceSynchronousProcessAfterRefresh |
Gets and sets a property that indicates if the objects dependant on this query should be processed synchronously rather than asynchronously
|
|
GUID |
Gets and sets a GUID that uniquely identifies this object.
|
|
HasDependantObjects |
Gets a value that indicates whether any DashboardObjects are dependant on the data provided by this query.
|
|
HasOrphanedRequiredFields |
Returns True if query has reqiured fields that are not represented by a ControlPanelObject on the dashboard.
|
|
ID |
Gets a value that indicates the Unique ID of this object.
|
|
LastRefeshCancelled |
Gets a property that indicates if the last refresh was cancelled.
|
|
LastRefreshCompleted |
Gets the date and time the query last successfully completed refreshing.
|
|
LastRefreshStarted |
Gets the date and time the query last began a refresh operation.
|
|
Name |
Gets and sets a value that indicates the name of this query.
|
|
NextAutoRefresh |
Gets a value that indicates the time at which this dashboard query will be refreshed automatically.
|
|
NumRows |
Gets the total number of rows returned by this query.
|
|
OrphanedRequiredFields |
Gets a collection of RunDataPA.Field objects that represent the orphaned required fields for this query.
|
|
Parent |
Gets and sets object that represents the parent of this object.
|
|
Password |
Gets and sets the encrypted Password used by the Enterprise Service to connect to an appserver when refreshing this query.
|
|
Query |
Gets and sets the Query object this DashboardQuery is based on.
|
|
QueryErrorMessage |
Gets and sets an error message returned by the query at the last refresh.
|
|
QueryString | ||
QueuedForRefresh |
Gets a value that indicates if this query is queued for refresh.
|
|
RefreshesAcrossMultipleConnections |
Gets a property that indicates if this query refreshes across multiple connections
|
|
Refreshing |
Gets a value that indicates whether the current query is refreshing.
|
|
refreshInterval |
Gets and sets a value that indicates how often the query will auto refresh.
|
|
RefreshOnOpen |
Gets and sets a value that indicates if the query will auto refresh when the dashboard is opened.
|
|
RefreshOnPublish |
Gets and sets a property that indicates if this query will be refreshed on publish
|
|
ResultsSet |
Gets and sets the results set for this query.
|
|
SaveDataFailed |
Gets a property that indicates if the query data failed to serialize during the last serialzation process.
|
|
SaveDataFailException |
Gets the exception that indicates why the query data failed to serialize during the last serialzation process.
|
|
SQLQueryString |
Returns the SQL query string for this query if this query uses one.
|
|
SubjectID |
Returns the UniqueID of the subject for this query.
|
|
SupportsCollate |
Gets a value that indicates if this query supports data collation.
|
|
SystemName |
Returns the System name the subject for this query belongs to.
|
|
Username |
Gets and sets the username used by the Enterprise Service to connect to an appserver when refreshing this query.
|
|
ValidSubject |
Gets a value that indicates if the subject for this query exists.
|
Events
Name | Description | |
---|---|---|
ServerRequestComplete |
Event raised when a server request raised by this object is completed.
|