Class NSListEntity
The list entity contains information about a specific list.
Constructors
NSListEntity()
Initializes a new instance of the NSListEntity class.
Declaration
NSListEntityMethods
GetDeleted()
Declaration
Bool GetDeleted()Examples
NSListEntity thing;
Bool deleted = thing.GetDeleted();Returns
| Type | Description |
| Bool | True if the list item is marked as deleted. |
GetId()
Declaration
Integer GetId()Examples
NSListEntity thing;
Integer id = thing.GetId();Returns
| Type | Description |
| Integer | The identity of the list. |
GetInUseByUserDefinedFields()
Declaration
Bool GetInUseByUserDefinedFields()Examples
NSListEntity thing;
Bool inUseByUserDefinedFields = thing.GetInUseByUserDefinedFields();Returns
| Type | Description |
| Bool | True if this in use by one or more udfields. |
GetIsCustomList()
Declaration
Bool GetIsCustomList()Examples
NSListEntity thing;
Bool isCustomList = thing.GetIsCustomList();Returns
| Type | Description |
| Bool | Indicates if this is a custom list or a standard list. |
GetIsMDOList()
Declaration
Bool GetIsMDOList()Examples
NSListEntity thing;
Bool isMDOList = thing.GetIsMDOList();Returns
| Type | Description |
| Bool | Indicates if this is an MDO list. |
GetListType()
Declaration
String GetListType()Examples
NSListEntity thing;
String listType = thing.GetListType();Returns
| Type | Description |
| String | The type of this list, often indicated by the database name, but not necessarily. |
GetName()
Declaration
String GetName()Examples
NSListEntity thing;
String name = thing.GetName();Returns
| Type | Description |
| String | The name of the list. |
GetRank()
Declaration
Integer GetRank()Examples
NSListEntity thing;
Integer rank = thing.GetRank();Returns
| Type | Description |
| Integer | The rank of the list. |
GetTooltip()
Declaration
String GetTooltip()Examples
NSListEntity thing;
String tooltip = thing.GetTooltip();Returns
| Type | Description |
| String | The tooltip of the list. |
GetUseGroupsAndHeadings()
Declaration
Bool GetUseGroupsAndHeadings()Examples
NSListEntity thing;
Bool useGroupsAndHeadings = thing.GetUseGroupsAndHeadings();Returns
| Type | Description |
| Bool | Indicates if this list should use groups and headings. |
SetDeleted(Bool)
Declaration
Void SetDeleted(Bool deleted)Examples
NSListEntity thing;
Bool deleted;
thing.SetDeleted(deleted);Parameters
| Type | Name | Description |
| Bool | deleted | True if the list item is marked as deleted. |
Returns
| Type | Description |
| Void |
SetId(Integer)
Declaration
Void SetId(Integer id)Examples
NSListEntity thing;
Integer id;
thing.SetId(id);Parameters
| Type | Name | Description |
| Integer | id | The identity of the list. |
Returns
| Type | Description |
| Void |
SetInUseByUserDefinedFields(Bool)
Declaration
Void SetInUseByUserDefinedFields(Bool inUseByUserDefinedFields)Examples
NSListEntity thing;
Bool inUseByUserDefinedFields;
thing.SetInUseByUserDefinedFields(inUseByUserDefinedFields);Parameters
| Type | Name | Description |
| Bool | inUseByUserDefinedFields | True if this in use by one or more udfields. |
Returns
| Type | Description |
| Void |
SetIsCustomList(Bool)
Declaration
Void SetIsCustomList(Bool isCustomList)Examples
NSListEntity thing;
Bool isCustomList;
thing.SetIsCustomList(isCustomList);Parameters
| Type | Name | Description |
| Bool | isCustomList | Indicates if this is a custom list or a standard list. |
Returns
| Type | Description |
| Void |
SetIsMDOList(Bool)
Declaration
Void SetIsMDOList(Bool isMDOList)Examples
NSListEntity thing;
Bool isMDOList;
thing.SetIsMDOList(isMDOList);Parameters
| Type | Name | Description |
| Bool | isMDOList | Indicates if this is an MDO list. |
Returns
| Type | Description |
| Void |
SetListType(String)
Declaration
Void SetListType(String listType)Examples
NSListEntity thing;
String listType;
thing.SetListType(listType);Parameters
| Type | Name | Description |
| String | listType | The type of this list, often indicated by the database name, but not necessarily. |
Returns
| Type | Description |
| Void |
SetName(String)
Declaration
Void SetName(String name)Examples
NSListEntity thing;
String name;
thing.SetName(name);Parameters
| Type | Name | Description |
| String | name | The name of the list. |
Returns
| Type | Description |
| Void |
SetRank(Integer)
Declaration
Void SetRank(Integer rank)Examples
NSListEntity thing;
Integer rank;
thing.SetRank(rank);Parameters
| Type | Name | Description |
| Integer | rank | The rank of the list. |
Returns
| Type | Description |
| Void |
SetTooltip(String)
Declaration
Void SetTooltip(String tooltip)Examples
NSListEntity thing;
String tooltip;
thing.SetTooltip(tooltip);Parameters
| Type | Name | Description |
| String | tooltip | The tooltip of the list. |
Returns
| Type | Description |
| Void |
SetUseGroupsAndHeadings(Bool)
Declaration
Void SetUseGroupsAndHeadings(Bool useGroupsAndHeadings)Examples
NSListEntity thing;
Bool useGroupsAndHeadings;
thing.SetUseGroupsAndHeadings(useGroupsAndHeadings);Parameters
| Type | Name | Description |
| Bool | useGroupsAndHeadings | Indicates if this list should use groups and headings. |
Returns
| Type | Description |
| Void |