Show / Hide Table of Contents

Class NSListItemEntity

The list item entity contains generic list item information.

Syntax

Constructors

NSListItemEntity()

Initializes a new instance of the NSListItemEntity class.

Declaration
NSListItemEntity

Methods

GetDeleted()

The list item entity contains generic list item information.

Declaration
Bool GetDeleted()
Returns
Type Description
Bool

True if the list item is marked as deleted.

Examples
NSListItemEntity thing;
Bool deleted = thing.GetDeleted();

GetId()

The list item entity contains generic list item information.

Declaration
Integer GetId()
Returns
Type Description
Integer

The identity of the list item.

Examples
NSListItemEntity thing;
Integer id = thing.GetId();

GetName()

The list item entity contains generic list item information.

Declaration
String GetName()
Returns
Type Description
String

The name of the list item.

Examples
NSListItemEntity thing;
String name = thing.GetName();

GetRank()

The list item entity contains generic list item information.

Declaration
Integer GetRank()
Returns
Type Description
Integer

The rank of the list item.

Examples
NSListItemEntity thing;
Integer rank = thing.GetRank();

GetTooltip()

The list item entity contains generic list item information.

Declaration
String GetTooltip()
Returns
Type Description
String

The tooltip of the list item.

Examples
NSListItemEntity thing;
String tooltip = thing.GetTooltip();

GetUdListDefinitionId()

The list item entity contains generic list item information.

Declaration
Integer GetUdListDefinitionId()
Returns
Type Description
Integer

The ID of the list which this list item belongs to.

Examples
NSListItemEntity thing;
Integer udListDefinitionId = thing.GetUdListDefinitionId();

SetDeleted(Bool)

The list item entity contains generic list item information.

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
NSListItemEntity thing;
Bool deleted;
thing.SetDeleted(deleted);

SetId(Integer)

The list item entity contains generic list item information.

Declaration
Void SetId(Integer id)
Parameters
Type Name Description
Integer id

The identity of the list item.

Returns
Type Description
Void
Examples
NSListItemEntity thing;
Integer id;
thing.SetId(id);

SetName(String)

The list item entity contains generic list item information.

Declaration
Void SetName(String name)
Parameters
Type Name Description
String name

The name of the list item.

Returns
Type Description
Void
Examples
NSListItemEntity thing;
String name;
thing.SetName(name);

SetRank(Integer)

The list item entity contains generic list item information.

Declaration
Void SetRank(Integer rank)
Parameters
Type Name Description
Integer rank

The rank of the list item.

Returns
Type Description
Void
Examples
NSListItemEntity thing;
Integer rank;
thing.SetRank(rank);

SetTooltip(String)

The list item entity contains generic list item information.

Declaration
Void SetTooltip(String tooltip)
Parameters
Type Name Description
String tooltip

The tooltip of the list item.

Returns
Type Description
Void
Examples
NSListItemEntity thing;
String tooltip;
thing.SetTooltip(tooltip);

SetUdListDefinitionId(Integer)

The list item entity contains generic list item information.

Declaration
Void SetUdListDefinitionId(Integer udListDefinitionId)
Parameters
Type Name Description
Integer udListDefinitionId

The ID of the list which this list item belongs to.

Returns
Type Description
Void
Examples
NSListItemEntity thing;
Integer udListDefinitionId;
thing.SetUdListDefinitionId(udListDefinitionId);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top