Class DashTheme

Dashboard theme configuration

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

Get DashTheme 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Constructors

DashTheme()

Default constructor

Declaration
public DashTheme()
Examples

Get DashTheme 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Properties

Client

Name of client(s) this theme is available to

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

Get DashTheme 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Config

The JSON clob-formatted config

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

Get DashTheme 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

DashboardThemeId

Primary key

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

Get DashTheme 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Name

The name of this theme

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

Get DashTheme 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Rank

Rank order

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

Get DashTheme 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Style

Style value - for example 'light' or 'dark'

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

Get DashTheme 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

See Also