Class DashTile

Dashboard Tile configuration

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

Get DashTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Constructors

DashTile()

Default constructor

Declaration
public DashTile()
Examples

Get DashTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Properties

DashboardId

The associated dashboard

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

Get DashTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

DashboardTileId

Primary key

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

Get DashTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

DashTileDefinition

The tile definition entity

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

Get DashTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Height

Height used by this tile in the dashboard

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

Get DashTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Rank

Rank order

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

Get DashTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Width

Width used by this tile in the dashboard

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

Get DashTile 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

See Also