Back to API Home

Retrieves an instance of the DashboardDefinition class specified by its ID.

Namespace: Dundas.Dashboard.Business
Assembly: Dundas.Dashboard.Client (in Dundas.Dashboard.Client.dll) Version: 5.0.0.0 (5.5.0.1000)

Syntax

C#
[ScriptExcludeAttribute]
public static void GetAsync(
	Guid id,
	bool getForViewing,
	OnCompleted<DashboardDefinition> callback
)
Visual Basic
<ScriptExcludeAttribute> 
Public Shared Sub GetAsync ( 
	id As Guid,
	getForViewing As Boolean,
	callback As OnCompleted(Of DashboardDefinition)
)

Parameters

id
Type: System..::..Guid
ID of the dashboard to retrieve.
getForViewing
Type: System..::..Boolean
If trueTruetruetrue (True in Visual Basic)gets the dashboard for viewing; otherwise gets the (previously checked out) dashboard for editing.
callback
Type: Dundas.Dashboard..::..OnCompleted<(Of <(<'DashboardDefinition>)>)>
The callback for handling the completion event.

Exceptions

ExceptionCondition
Dundas.Dashboard..::..ObjectNotFoundExceptionThe dashboard does not exist.
Dundas.Dashboard..::..NoPrivilegeExceptionNo privilege for attempted operation.
Dundas.Dashboard..::..InvalidSessionExceptionYour session is no longer valid.

See Also