Class Dash

Dashboard configuration

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

Get Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 123 );
 }

Constructors

Dash()

Default constructor

Declaration
public Dash()
Examples

Get Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 123 );
 }
See Also

Properties

AssociateId

Associate who owns this dashboard

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

Get Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 123 );
 }
See Also

Columns

How many columns there will be in the dashboard.

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

Get Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 123 );
 }
See Also

DashboardId

Primary key

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

Get Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 123 );
 }
See Also

Description

Detailed description

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

Get Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 123 );
 }
See Also

Name

The name of this dashboard

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

Get Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 123 );
 }
See Also

PinForAll

True if pinned for all

Declaration
public virtual short PinForAll { get; set; }
Property Value
Type Description
Int16
Examples

Get Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 123 );
 }
See Also

PinForAssociates

Array of references to the pinned associates

Declaration
public virtual int[] PinForAssociates { get; set; }
Property Value
Type Description
Int32[]
Examples

Get Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 123 );
 }
See Also

PinForGroups

Array of references to the pinned groups

Declaration
public virtual int[] PinForGroups { get; set; }
Property Value
Type Description
Int32[]
Examples

Get Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 123 );
 }
See Also

Theme

The theme for this dashboard

Declaration
public virtual DashTheme Theme { get; set; }
Property Value
Type Description
DashTheme
Examples

Get Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 123 );
 }
See Also

UniqueId

GUID identifying a default dashboard from SuperOffice

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

Get Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 123 );
 }
See Also

VisibleForAll

True if visible for all

Declaration
public virtual short VisibleForAll { get; set; }
Property Value
Type Description
Int16
Examples

Get Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 123 );
 }
See Also

VisibleForAssociates

Array of references to the visible for associates

Declaration
public virtual int[] VisibleForAssociates { get; set; }
Property Value
Type Description
Int32[]
Examples

Get Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 123 );
 }
See Also

VisibleForGroups

Array of references to the visible for groups

Declaration
public virtual int[] VisibleForGroups { get; set; }
Property Value
Type Description
Int32[]
Examples

Get Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 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 Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 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 Dash 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashAgent();
    var dash = agent.GetDash( 123 );
 }
See Also

See Also