Class Dashboard

Dashboard configuration

Carrier object for Dashboard. Services for the Dashboard Carrier is available from the IDashboardAgent.
Inheritance
Object
Dashboard
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class Dashboard : Carrier
Examples

Get Dashboard 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashboardAgent();
    var dashboard = agent.GetDashboard( 123 );
 }

Constructors

Dashboard()

Default constructor

Declaration
public Dashboard()
Examples

Get Dashboard 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashboardAgent();
    var dashboard = agent.GetDashboard( 123 );
 }
See Also

Properties

AssociateId

Id of the associate who owns this dashboard

Declaration
public virtual int AssociateId { get; set; }
Property Value
Type Description
Int32
Examples

Get Dashboard 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashboardAgent();
    var dashboard = agent.GetDashboard( 123 );
 }
See Also

Caption

The caption for this dashboard

Declaration
public virtual string Caption { get; set; }
Property Value
Type Description
String
Examples

Get Dashboard 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashboardAgent();
    var dashboard = agent.GetDashboard( 123 );
 }
See Also

DashboardId

The dashboard id

Declaration
public virtual int DashboardId { get; set; }
Property Value
Type Description
Int32
Examples

Get Dashboard 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashboardAgent();
    var dashboard = agent.GetDashboard( 123 );
 }
See Also

Layout

The dashboard layout, how the tiles are organized on the screen

Declaration
public virtual DashboardLayout Layout { get; set; }
Property Value
Type Description
DashboardLayout
Examples

Get Dashboard 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashboardAgent();
    var dashboard = agent.GetDashboard( 123 );
 }
See Also

Tiles

The tiles associated with this dashboard

Declaration
public virtual DashboardTile[] Tiles { get; set; }
Property Value
Type Description
DashboardTile[]
Examples

Get Dashboard 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashboardAgent();
    var dashboard = agent.GetDashboard( 123 );
 }
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.
Examples

Get Dashboard 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashboardAgent();
    var dashboard = agent.GetDashboard( 123 );
 }
See Also

ToString(String)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
String prefix

The line prefix (typically used for indenting)
Returns
Type Description
String

The carrier contents.
Examples

Get Dashboard 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashboardAgent();
    var dashboard = agent.GetDashboard( 123 );
 }
See Also

See Also