Class DashboardTile

Dashboard Tile configuration

Carrier object for DashboardTile. Services for the DashboardTile Carrier is available from the IDashboardAgent.
Inheritance
object
DashboardTile
Implements
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class DashboardTile : Carrier, IVisibleForCarrier
Examples

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Constructors

DashboardTile()

Default constructor

Declaration
public DashboardTile()
Examples

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Properties

AssociateId

Id of the associate who owns this tile

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

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Caption

The tile caption

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

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

ChartId

The original chart Id

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

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

ChartName

The original chart name

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

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Config

The tile config

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

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

DashboardTileId

The tile id

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

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Description

The tile description

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

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

EntityType

The tile entity type

Declaration
public virtual DashboardTileEntityType EntityType { get; set; }
Property Value
Type Description
DashboardTileEntityType
Examples

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

GroupId

Id of the associates primary group at storage time

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

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

IsDefault

True if this is one of the default tiles

Declaration
public virtual bool IsDefault { get; set; }
Property Value
Type Description
Boolean
Examples

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Options

The tile options

Declaration
public virtual DashboardTileOption[] Options { get; set; }
Property Value
Type Description
DashboardTileOption[]
Examples

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

SelectionId

The selection that defines the data filter/restrictions

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

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Type

The tile type, what kind of tile this is

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

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

VisibleFor

The set of users or groups the record is visible for

Declaration
public VisibleFor[] VisibleFor { get; set; }
Property Value
Type Description
VisibleFor[]
Examples

Get DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashboardAgent();
    var dashboardTile = agent.GetDashboardTile( 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 DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DashboardAgent();
    var dashboardTile = agent.GetDashboardTile( 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 DashboardTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Implements

See Also