Class NSArchiveListItem
Constructors
NSArchiveListItem()
Initializes a new instance of the NSArchiveListItem class.
Declaration
NSArchiveListItemMethods
GetColumnData()
Declaration
Map GetColumnData()Examples
NSArchiveListItem thing;
Map columnData = thing.GetColumnData();Returns
| Type | Description |
| Map | Map of column name - column data items. |
GetEntityName()
Declaration
String GetEntityName()Examples
NSArchiveListItem thing;
String entityName = thing.GetEntityName();Returns
| Type | Description |
| String | The entity name of the NSArchiveListItem. |
GetLinkHint()
Declaration
String GetLinkHint()Examples
NSArchiveListItem thing;
String linkHint = thing.GetLinkHint();Returns
| Type | Description |
| String | Link hint for the row, indicating things like navigation links that can be presented as clickable hyperlinks. |
GetPrimaryKey()
Declaration
Integer GetPrimaryKey()Examples
NSArchiveListItem thing;
Integer primaryKey = thing.GetPrimaryKey();Returns
| Type | Description |
| Integer | The primary key for the row. |
GetStyleHint()
Declaration
String GetStyleHint()Examples
NSArchiveListItem thing;
String styleHint = thing.GetStyleHint();Returns
| Type | Description |
| String | Style hint for the row, for instance 'retired' for associates or 'private' for appointments. |
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)Examples
NSArchiveListItem thing;
Map columnData;
thing.SetColumnData(columnData);Parameters
| Type | Name | Description |
| Map | columnData | column name - column data items. |
Returns
| Type | Description |
| Void |
SetEntityName(String)
Declaration
Void SetEntityName(String entityName)Examples
NSArchiveListItem thing;
String entityName;
thing.SetEntityName(entityName);Parameters
| Type | Name | Description |
| String | entityName | The entity name of the NSArchiveListItem. |
Returns
| Type | Description |
| Void |
SetLinkHint(String)
Declaration
Void SetLinkHint(String linkHint)Examples
NSArchiveListItem thing;
String linkHint;
thing.SetLinkHint(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 |
SetPrimaryKey(Integer)
Declaration
Void SetPrimaryKey(Integer primaryKey)Examples
NSArchiveListItem thing;
Integer primaryKey;
thing.SetPrimaryKey(primaryKey);Parameters
| Type | Name | Description |
| Integer | primaryKey | The primary key for the row. |
Returns
| Type | Description |
| Void |
SetStyleHint(String)
Declaration
Void SetStyleHint(String styleHint)Examples
NSArchiveListItem thing;
String styleHint;
thing.SetStyleHint(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 |