Class NSArchiveListItem

Syntax

Constructors

NSArchiveListItem()

Initializes a new instance of the NSArchiveListItem class.

Declaration

NSArchiveListItem

Methods

GetColumnData()

Declaration

Map GetColumnData()

Returns

Type	Description
Map	Map of column name - column data items.

Remarks

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.

Examples

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

GetEntityName()

Declaration

String GetEntityName()

Returns

Type	Description
String	The entity name of the NSArchiveListItem.

Remarks

An ArchiveList may contain rows from different entities.

Examples

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

GetLinkHint()

Declaration

String GetLinkHint()

Returns

Type	Description
String	Link hint for the row, indicating things like navigation links that can be presented as clickable hyperlinks.

Examples

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

GetPrimaryKey()

Declaration

Integer GetPrimaryKey()

Returns

Type	Description
Integer	The primary key for the row.

Examples

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

GetStyleHint()

Declaration

String GetStyleHint()

Returns

Type	Description
String	Style hint for the row, for instance 'retired' for associates or 'private' for appointments.

Remarks

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

Examples

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.

Declaration

Void SetColumnData(Map columnData)

Parameters

Type	Name	Description
Map	columnData	column name - column data items.

Returns

Type	Description
Void

Examples

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

SetEntityName(String)

Declaration

Void SetEntityName(String entityName)

Parameters

Type	Name	Description
String	entityName	The entity name of the NSArchiveListItem.

Returns

Type	Description
Void

Remarks

An ArchiveList may contain rows from different entities.

Examples

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

SetLinkHint(String)

Declaration

Void SetLinkHint(String linkHint)

Parameters

Type	Name	Description
String	linkHint	Link hint for the row, indicating things like navigation links that can be presented as clickable hyperlinks.

Returns

Type	Description
Void

Examples

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

SetPrimaryKey(Integer)

Declaration

Void SetPrimaryKey(Integer primaryKey)

Parameters

Type	Name	Description
Integer	primaryKey	The primary key for the row.

Returns

Type	Description
Void

Examples

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

SetStyleHint(String)

Declaration

Void SetStyleHint(String styleHint)

Parameters

Type	Name	Description
String	styleHint	Style hint for the row, for instance 'retired' for associates or 'private' for appointments.

Returns

Type	Description
Void

Remarks

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

Examples

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