NSArchiveListItem - SuperOffice

Constructors

NSArchiveListItem()

NSArchiveListItem

Initializes a new instance of the NSArchiveListItem class.

Methods

GetColumnData()

Map GetColumnData()

Returns: CRMScript.Native.Map - Map of column name - column data items.

Each column data item contains a display value, a tooltip hint, a link hint, and an orderby value. The display value is encoded by the CultureDataFormatter and can be decoded / localized by that class; all other values are optional.Tooltip hints can be passed to the TooltipProvider (Tooltip service) to be translated into an actual tooltip.

Example:

NSArchiveListItem thing;
Map columnData = thing.GetColumnData();

GetEntityName()

String GetEntityName()

Returns: CRMScript.Global.String - The entity name of the NSArchiveListItem.

An ArchiveList may contain rows from different entities.

Example:

NSArchiveListItem thing;
String entityName = thing.GetEntityName();

GetLinkHint()

String GetLinkHint()

Returns: CRMScript.Global.String - Link hint for the row, indicating things like navigation links that can be presented as clickable hyperlinks. Example:

NSArchiveListItem thing;
String linkHint = thing.GetLinkHint();

GetPrimaryKey()

Integer GetPrimaryKey()

Returns: CRMScript.Global.Integer - The primary key for the row. Example:

NSArchiveListItem thing;
Integer primaryKey = thing.GetPrimaryKey();

GetStyleHint()

String GetStyleHint()

Returns: CRMScript.Global.String - Style hint for the row, for instance ‘retired’ for associates or ‘private’ for appointments.

Presentation layers can interpret the style hints as they see fit.

Example:

NSArchiveListItem thing;
String styleHint = thing.GetStyleHint();

SetColumnData(Map)

Each column data item contains a display value, a tooltip hint, a link hint, and an ORDERBY value. The display value is encoded by the CultureDataFormatter and can be decoded or localized by that class. All other values are optional. Tooltip hints can be passed to the TooltipProvider (Tooltip service) to be translated into an actual tooltip.

Void SetColumnData(Map columnData)

Returns: CRMScript.Global.Void Example:

NSArchiveListItem thing;
Map columnData;
thing.SetColumnData(columnData);

SetEntityName(String)

Void SetEntityName(String entityName)

Returns: CRMScript.Global.Void

An ArchiveList may contain rows from different entities.

Example:

NSArchiveListItem thing;
String entityName;
thing.SetEntityName(entityName);

SetLinkHint(String)

Void SetLinkHint(String linkHint)

Returns: CRMScript.Global.Void Example:

NSArchiveListItem thing;
String linkHint;
thing.SetLinkHint(linkHint);

SetPrimaryKey(Integer)

Void SetPrimaryKey(Integer primaryKey)

Returns: CRMScript.Global.Void Example:

NSArchiveListItem thing;
Integer primaryKey;
thing.SetPrimaryKey(primaryKey);

SetStyleHint(String)

Void SetStyleHint(String styleHint)

Returns: CRMScript.Global.Void

Presentation layers can interpret the style hints as they see fit.

Example:

NSArchiveListItem thing;
String styleHint;
thing.SetStyleHint(styleHint);

​Constructors