Class NSListEntity

The list entity contains information about a specific list.

Syntax

Constructors

NSListEntity()

Initializes a new instance of the NSListEntity class.

Declaration

NSListEntity

Methods

GetDeleted()

The list entity contains information about a specific list.

Declaration

Bool GetDeleted()

Returns

Type	Description
Bool	True if the list item is marked as deleted.

Examples

NSListEntity thing;
Bool deleted = thing.GetDeleted();

GetId()

The list entity contains information about a specific list.

Declaration

Integer GetId()

Returns

Type	Description
Integer	The identity of the list.

Examples

NSListEntity thing;
Integer id = thing.GetId();

GetInUseByUserDefinedFields()

The list entity contains information about a specific list.

Declaration

Bool GetInUseByUserDefinedFields()

Returns

Type	Description
Bool	True if this in use by one or more udfields.

Examples

NSListEntity thing;
Bool inUseByUserDefinedFields = thing.GetInUseByUserDefinedFields();

GetIsCustomList()

The list entity contains information about a specific list.

Declaration

Bool GetIsCustomList()

Returns

Type	Description
Bool	Indicates if this is a custom list or a standard list.

Examples

NSListEntity thing;
Bool isCustomList = thing.GetIsCustomList();

GetIsMDOList()

The list entity contains information about a specific list.

Declaration

Bool GetIsMDOList()

Returns

Type	Description
Bool	Indicates if this is an MDO list.

Examples

NSListEntity thing;
Bool isMDOList = thing.GetIsMDOList();

GetListType()

The list entity contains information about a specific list.

Declaration

String GetListType()

Returns

Type	Description
String	The type of this list, often indicated by the database name, but not necessarily.

Examples

NSListEntity thing;
String listType = thing.GetListType();

GetName()

The list entity contains information about a specific list.

Declaration

String GetName()

Returns

Type	Description
String	The name of the list.

Examples

NSListEntity thing;
String name = thing.GetName();

GetRank()

The list entity contains information about a specific list.

Declaration

Integer GetRank()

Returns

Type	Description
Integer	The rank of the list.

Examples

NSListEntity thing;
Integer rank = thing.GetRank();

GetTooltip()

The list entity contains information about a specific list.

Declaration

String GetTooltip()

Returns

Type	Description
String	The tooltip of the list.

Examples

NSListEntity thing;
String tooltip = thing.GetTooltip();

GetUseGroupsAndHeadings()

The list entity contains information about a specific list.

Declaration

Bool GetUseGroupsAndHeadings()

Returns

Type	Description
Bool	Indicates if this list should use groups and headings.

Examples

NSListEntity thing;
Bool useGroupsAndHeadings = thing.GetUseGroupsAndHeadings();

SetDeleted(Bool)

The list entity contains information about a specific list.

Declaration

Void SetDeleted(Bool deleted)

Parameters

Type	Name	Description
Bool	deleted	True if the list item is marked as deleted.

Returns

Type	Description
Void

Examples

NSListEntity thing;
Bool deleted;
thing.SetDeleted(deleted);

SetId(Integer)

The list entity contains information about a specific list.

Declaration

Void SetId(Integer id)

Parameters

Type	Name	Description
Integer	id	The identity of the list.

Returns

Type	Description
Void

Examples

NSListEntity thing;
Integer id;
thing.SetId(id);

SetInUseByUserDefinedFields(Bool)

The list entity contains information about a specific list.

Declaration

Void SetInUseByUserDefinedFields(Bool inUseByUserDefinedFields)

Parameters

Type	Name	Description
Bool	inUseByUserDefinedFields	True if this in use by one or more udfields.

Returns

Type	Description
Void

Examples

NSListEntity thing;
Bool inUseByUserDefinedFields;
thing.SetInUseByUserDefinedFields(inUseByUserDefinedFields);

SetIsCustomList(Bool)

The list entity contains information about a specific list.

Declaration

Void SetIsCustomList(Bool isCustomList)

Parameters

Type	Name	Description
Bool	isCustomList	Indicates if this is a custom list or a standard list.

Returns

Type	Description
Void

Examples

NSListEntity thing;
Bool isCustomList;
thing.SetIsCustomList(isCustomList);

SetIsMDOList(Bool)

The list entity contains information about a specific list.

Declaration

Void SetIsMDOList(Bool isMDOList)

Parameters

Type	Name	Description
Bool	isMDOList	Indicates if this is an MDO list.

Returns

Type	Description
Void

Examples

NSListEntity thing;
Bool isMDOList;
thing.SetIsMDOList(isMDOList);

SetListType(String)

The list entity contains information about a specific list.

Declaration

Void SetListType(String 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

Examples

NSListEntity thing;
String listType;
thing.SetListType(listType);

SetName(String)

The list entity contains information about a specific list.

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	The name of the list.

Returns

Type	Description
Void

Examples

NSListEntity thing;
String name;
thing.SetName(name);

SetRank(Integer)

The list entity contains information about a specific list.

Declaration

Void SetRank(Integer rank)

Parameters

Type	Name	Description
Integer	rank	The rank of the list.

Returns

Type	Description
Void

Examples

NSListEntity thing;
Integer rank;
thing.SetRank(rank);

SetTooltip(String)

The list entity contains information about a specific list.

Declaration

Void SetTooltip(String tooltip)

Parameters

Type	Name	Description
String	tooltip	The tooltip of the list.

Returns

Type	Description
Void

Examples

NSListEntity thing;
String tooltip;
thing.SetTooltip(tooltip);

SetUseGroupsAndHeadings(Bool)

The list entity contains information about a specific list.

Declaration

Void SetUseGroupsAndHeadings(Bool useGroupsAndHeadings)

Parameters

Type	Name	Description
Bool	useGroupsAndHeadings	Indicates if this list should use groups and headings.

Returns

Type	Description
Void

Examples

NSListEntity thing;
Bool useGroupsAndHeadings;
thing.SetUseGroupsAndHeadings(useGroupsAndHeadings);