Show / Hide Table of Contents

Class DashboardTileOption

Dashboard Tile option

Carrier object for DashboardTileOption. Services for the DashboardTileOption Carrier is available from the IDashboardAgent.
Inheritance
object
DashboardTileOption
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class DashboardTileOption : Carrier

Constructors

DashboardTileOption()

Default constructor

Declaration
public DashboardTileOption()
See Also
DashboardAgent
IDashboardAgent

Properties

DefaultDataOption

True if this option only applies to the default data source, not selections

Declaration
public virtual bool DefaultDataOption { get; set; }
Property Value
Type Description
Boolean
See Also
DashboardAgent
IDashboardAgent

Description

Option description, visible to users

Declaration
public virtual string Description { get; set; }
Property Value
Type Description
String
See Also
DashboardAgent
IDashboardAgent

ListItems

List options given directly, not via MDO list name

Declaration
public virtual MDOListItem[] ListItems { get; set; }
Property Value
Type Description
MDOListItem[]
See Also
DashboardAgent
IDashboardAgent

ListName

An MDO list name, used if the type is list and no ListOptions are given

Declaration
public virtual string ListName { get; set; }
Property Value
Type Description
String
See Also
DashboardAgent
IDashboardAgent

Name

Name of option, usually not visible to users

Declaration
public virtual string Name { get; set; }
Property Value
Type Description
String
See Also
DashboardAgent
IDashboardAgent

Type

The type of option - integer, list, boolean (checkbox) etc.

Declaration
public virtual DashboardTileOptionType Type { get; set; }
Property Value
Type Description
DashboardTileOptionType
See Also
DashboardAgent
IDashboardAgent

Value

The value, encoded as string, Id:Name of list item if type is list

Declaration
public virtual string Value { get; set; }
Property Value
Type Description
String
See Also
DashboardAgent
IDashboardAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.

See Also
DashboardAgent
IDashboardAgent

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.

See Also
DashboardAgent
IDashboardAgent

See Also

DashboardAgent
IDashboardAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top