Class NSHeadingEntity

The heading entity contains generic list item information.

Syntax

Constructors

NSHeadingEntity()

Initializes a new instance of the NSHeadingEntity class.

Declaration

NSHeadingEntity

Methods

GetDeleted()

The heading entity contains generic list item information.

Declaration

Bool GetDeleted()

Returns

Type	Description
Bool	True if the heading is marked as deleted.

Examples

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

GetHeadingId()

The heading entity contains generic list item information.

Declaration

Integer GetHeadingId()

Returns

Type	Description
Integer	Primary key.

Examples

NSHeadingEntity thing;
Integer headingId = thing.GetHeadingId();

GetName()

The heading entity contains generic list item information.

Declaration

String GetName()

Returns

Type	Description
String	The visible heading.

Examples

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

GetRank()

The heading entity contains generic list item information.

Declaration

Integer GetRank()

Returns

Type	Description
Integer	Rank order.

Examples

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

GetTooltip()

The heading entity contains generic list item information.

Declaration

String GetTooltip()

Returns

Type	Description
String	Tooltip or other description.

Examples

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

GetUdListDefinitionId()

The heading entity contains generic list item information.

Declaration

Integer GetUdListDefinitionId()

Returns

Type	Description
Integer	The ID of the list which this heading belongs to.

Examples

NSHeadingEntity thing;
Integer udListDefinitionId = thing.GetUdListDefinitionId();

SetDeleted(Bool)

The heading entity contains generic list item information.

Declaration

Void SetDeleted(Bool deleted)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetHeadingId(Integer)

The heading entity contains generic list item information.

Declaration

Void SetHeadingId(Integer headingId)

Parameters

Type	Name	Description
Integer	headingId	Primary key.

Returns

Type	Description
Void

Examples

NSHeadingEntity thing;
Integer headingId;
thing.SetHeadingId(headingId);

SetName(String)

The heading entity contains generic list item information.

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	The visible heading.

Returns

Type	Description
Void

Examples

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

SetRank(Integer)

The heading entity contains generic list item information.

Declaration

Void SetRank(Integer rank)

Parameters

Type	Name	Description
Integer	rank	Rank order.

Returns

Type	Description
Void

Examples

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

SetTooltip(String)

The heading entity contains generic list item information.

Declaration

Void SetTooltip(String tooltip)

Parameters

Type	Name	Description
String	tooltip	Tooltip or other description.

Returns

Type	Description
Void

Examples

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

SetUdListDefinitionId(Integer)

The heading entity contains generic list item information.

Declaration

Void SetUdListDefinitionId(Integer udListDefinitionId)

Parameters

Type	Name	Description
Integer	udListDefinitionId	The ID of the list which this heading belongs to.

Returns

Type	Description
Void

Examples

NSHeadingEntity thing;
Integer udListDefinitionId;
thing.SetUdListDefinitionId(udListDefinitionId);