Class DashboardSaveEventArgs

Argument object passed to SaveDashboard event.

Inheritance

System.Object

System.EventArgs

DashboardSaveEventArgs

Inherited Members

System.EventArgs.Empty

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Reveal.Sdk

Assembly: Reveal.UI.Sdk.dll

Syntax

public class DashboardSaveEventArgs : EventArgs

Properties

IsSaveAs

A flag indicating if this event was originated by a 'save' (false) or 'save as' (true) operation.

Declaration

public bool IsSaveAs { get; }

Property Value

Type	Description
System.Boolean

Name

The name of the dashboard being saved.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

Methods

SaveFinished()

Notifies the Reveal SDK the save operation has finished and it should switch to view mode.

Declaration

public void SaveFinished()

Serialize()

Serializes the current dashboard to a byte array

Declaration

public Task<byte[]> Serialize()

Returns

Type	Description
System.Threading.Tasks.Task<System.Byte[]>	a byte array with the contents of the dashboard in rdash format

SerializeAsJson()

Serializes the current dashboard to JSON string

Declaration

public Task<string> SerializeAsJson()

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	a byte array with the contents of the dashboard in rdash format

SerializeWithNewName(String)

Serializes the current dashboard in '.rdash' format to a byte array, the title of the dashboard is changed to match the specified name.

Declaration

public Task<byte[]> SerializeWithNewName(string newName)

Parameters

Type	Name	Description
System.String	newName	The new name of the dashboard, it changes the title attribute of the dashboard object

Returns

Type	Description
System.Threading.Tasks.Task<System.Byte[]>

SerializeWithNewNameAsJson(String)

Serializes the current dashboard to JSON string, the title of the dashboard is changed to match the specified name.

Declaration

public Task<string> SerializeWithNewNameAsJson(string newName)

Parameters

Type	Name	Description
System.String	newName	The new name of the dashboard, it changes the title attribute of the dashboard object

Returns

Type	Description
System.Threading.Tasks.Task<System.String>