Class DashTileDefinition

Dashboard Tile definition

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Constructors

DashTileDefinition()

Default constructor

Declaration
public DashTileDefinition()
Examples

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Properties

CurrencyCode

Currency code

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

CurrencyMode

Dashboard currency mode

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

DashboardTileDefinitionId

Primary key

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

DefaultHeight

Default height when added to a dashboard

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

DefaultWidth

Default width when added to a dashboard

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Description

Detailed description

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

EntityName

The entity measured by this tile, defines what provider to use

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

EntityType

Dashboard entity type

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

LayoutConfig

The JSON formatted layout config

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Measure

Dashboard measure type (Count, Sum, Avg, etc.)

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

MeasureByField

Field to group by

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

MeasureField

Field to be measured

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Name

The name of the tile

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

ProviderName

Name of provider to use with this entity type - read only property

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

SecondarySelectionId

Selection holding the replaced or changed criterias (period comparisons etc)

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

SelectionId

Selection holding the criterias for the tile definition

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

SortBy

Sort by field

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

TileType

Dashboard tile type

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Usage

Where this tile can be used

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

Get DashTileDefinition 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

See Also