Class NSUserGroup

The main user group that this user belongs to.

Syntax

Constructors

NSUserGroup()

Initializes a new instance of the NSUserGroup class.

Declaration

NSUserGroup

Methods

GetDeleted()

The main user group that this user belongs to.

Declaration

Bool GetDeleted()

Returns

Type	Description
Bool	true means that this is a user group that no longer can be selected by the user.

Remarks

It is not permitted to delete a UserGroup.

Examples

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

GetId()

The main user group that this user belongs to.

Declaration

Integer GetId()

Returns

Type	Description
Integer	Primary key.

Examples

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

GetRank()

The main user group that this user belongs to.

Declaration

Integer GetRank()

Returns

Type	Description
Integer	Rank order.

Examples

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

GetTooltip()

The main user group that this user belongs to.

Declaration

String GetTooltip()

Returns

Type	Description
String	Tooltip or other description.

Examples

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

GetValue()

The main user group that this user belongs to.

Declaration

String GetValue()

Returns

Type	Description
String	UserGroup name.

Examples

NSUserGroup thing;
String value = thing.GetValue();

SetDeleted(Bool)

Marks a user group.

Declaration

Void SetDeleted(Bool deleted)

Parameters

Type	Name	Description
Bool	deleted	true means that this is a user group that no longer can be selected by the user.

Returns

Type	Description
Void

Remarks

It is not permitted to delete a UserGroup.

Examples

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

SetId(Integer)

The main user group that this user belongs to.

Declaration

Void SetId(Integer id)

Parameters

Type	Name	Description
Integer	id	Primary key.

Returns

Type	Description
Void

Examples

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

SetRank(Integer)

The main user group that this user belongs to.

Declaration

Void SetRank(Integer rank)

Parameters

Type	Name	Description
Integer	rank	Rank order.

Returns

Type	Description
Void

Examples

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

SetTooltip(String)

The main user group that this user belongs to.

Declaration

Void SetTooltip(String tooltip)

Parameters

Type	Name	Description
String	tooltip	Tooltip or other description.

Returns

Type	Description
Void

Examples

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

SetValue(String)

The main user group that this user belongs to.

Declaration

Void SetValue(String value)

Parameters

Type	Name	Description
String	value	UserGroup name.

Returns

Type	Description
Void

Examples

NSUserGroup thing;
String value;
thing.SetValue(value);