Show / Hide Table of Contents

Class NSDash

Carrier object for NSDash.

Syntax

Constructors

NSDash()

Initializes a new instance of the NSDash class.

Declaration
NSDash

Methods

GetAssociateId()

Associate who owns this dashboard.

Declaration
Integer GetDescription()
Returns
Type Description
Integer

GetColumns()

How many columns there are in the dashboard.

Declaration
Integer GetColumns()
Returns
Type Description
Integer

GetDashboardId()

Primary key of dashboard.

Declaration
Integer GetDashboardId()
Returns
Type Description
Integer

GetDescription()

Detailed description of the dashboard.

Declaration
String GetDescription()
Returns
Type Description
String

GetName()

Gets name the dashboard.

Declaration
String GetName()
Returns
Type Description
String

GetPinForAll()

Returns 1 if pinned for all.

Declaration
Integer GetPinForAll()
Returns
Type Description
Integer

GetPinForAssociates()

Returns array of references to the pinned associates.

Declaration
Integer[] GetPinForAssociates()
Returns
Type Description
Integer[]

GetPinForGroups()

Returns array of references to the pinned groups.

Declaration
Integer[] GetPinForGroups()
Returns
Type Description
Integer[]

GetTheme()

Returns the theme for this dashboard.

Declaration
NSDashTheme GetTheme()
Returns
Type Description

GetUniqueId()

Returns GUID identifying a default dashboard from SuperOffice.

Declaration
String GetUniqueId()
Returns
Type Description
String

GetVisibleForAll()

Returns 1 if visible for all.

Declaration
Integer GetVisibleForAll()
Returns
Type Description
Integer

GetVisibleForAssociates()

Returns array of references to the visible for associates.

Declaration
Integer[] GetVisibleForAssociates()
Returns
Type Description
Integer[]

GetVisibleForGroups()

Returns array of references to the visible for groups.

Declaration
Integer[] GetVisibleForGroups()
Returns
Type Description
Integer[]

SetAssociateId(Integer)

Associate who owns this dashboard.

Declaration
Void SetAssociateId(Integer associateId)
Parameters
Type Name Description
Integer associateId
Returns
Type Description
Void

SetColumns(Integer)

How many columns there are in the dashboard.

Declaration
Void SetColumns(Integer cols)
Parameters
Type Name Description
Integer cols
Returns
Type Description
Void

SetDashboardId(Integer)

Primary key of dashboard.

Declaration
Void SetDashboardId(Integer dashId)
Parameters
Type Name Description
Integer dashId
Returns
Type Description
Void

SetDescription(String)

Detailed description of the dashboard.

Declaration
Void SetDescription(String desc)
Parameters
Type Name Description
String desc
Returns
Type Description
Void

SetName(String)

Sets name the dashboard.

Declaration
Void SetName(String name)
Parameters
Type Name Description
String name
Returns
Type Description
Void

SetPinForAll(Integer)

Set to 1 if pinned for all.

Declaration
Void SetPinForAll(Integer pinned)
Parameters
Type Name Description
Integer pinned
Returns
Type Description
Void

SetPinForAssociates(Integer[])

Set an array of references to pinned associates.

Declaration
Void SetPinForAssociates(Integer[] assocList)
Parameters
Type Name Description
Integer[] assocList
Returns
Type Description
Void

SetPinForGroups(Integer[])

Set an array of references to pinned groups.

Declaration
Void SetPinForGroups(Integer[] groups)
Parameters
Type Name Description
Integer[] groups
Returns
Type Description
Void

SetTheme(NSDashTheme)

Sets the theme for this dashboard.

Declaration
Void SetTheme(NSDashTheme theme)
Parameters
Type Name Description
NSDashTheme theme
Returns
Type Description
Void

SetUniqueId(String)

Sets GUID identifying a default dashboard from SuperOffice.

Declaration
Void SetUniqueId(String guid)
Parameters
Type Name Description
String guid
Returns
Type Description
Void

SetVisibleForAll(Integer)

Set to 1 if visible for all.

Declaration
Void SetVisibleForAll(Integer visible)
Parameters
Type Name Description
Integer visible
Returns
Type Description
Void

SetVisibleForAssociates(Integer[])

Set an array of references to visible for associates.

Declaration
Void SetVisibleForAssociates(Integer[] assocList)
Parameters
Type Name Description
Integer[] assocList
Returns
Type Description
Void

SetVisibleForGroups(Integer[])

Set an array of references to visible for groups.

Declaration
Void SetVisibleForGroups(Integer[] groups)
Parameters
Type Name Description
Integer[] groups
Returns
Type Description
Void
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top