Class NSPreferenceDescription

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Syntax

Constructors

NSPreferenceDescription()

Initializes a new instance of the NSPreferenceDescription class.

Declaration

NSPreferenceDescription

Methods

GetAccessFlags()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Integer GetAccessFlags()

Returns

Type	Description
Integer	See PrefDescAccessFlags.

Examples

NSPreferenceDescription thing;
Integer accessFlags = thing.GetAccessFlags();

GetDescription()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

String GetDescription()

Returns

Type	Description
String	Description of preference, multi-language parsed.

Examples

NSPreferenceDescription thing;
String description = thing.GetDescription();

GetIsBuiltin()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Bool GetIsBuiltin()

Returns

Type	Description
Bool	1 = This row populated and maintained by SuperOffice.

Examples

NSPreferenceDescription thing;
Bool isBuiltin = thing.GetIsBuiltin();

GetKey()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

String GetKey()

Returns

Type	Description
String	Preference key name.

Examples

NSPreferenceDescription thing;
String key = thing.GetKey();

GetMaxLevel()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Integer GetMaxLevel()

Returns

Type	Description
Integer	Lowest allowed setting level, set by user, but not lower than enum PreferenceLevel

Examples

NSPreferenceDescription thing;
Integer maxLevel = thing.GetMaxLevel();

GetMaxValue()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Integer GetMaxValue()

Returns

Type	Description
Integer	Max value (if type 1); list table ID (if type 5).

Examples

NSPreferenceDescription thing;
Integer maxValue = thing.GetMaxValue();

GetMinLevel()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Integer GetMinLevel()

Returns

Type	Description
Integer	The minimum (furthest away from User) level this preference can be set for.

Examples

NSPreferenceDescription thing;
Integer minLevel = thing.GetMinLevel();

GetMinValue()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Integer GetMinValue()

Returns

Type	Description
Integer	Min value (if type 1); list extra id (if type 5).

Examples

NSPreferenceDescription thing;
Integer minValue = thing.GetMinValue();

GetName()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

String GetName()

Returns

Type	Description
String	Multi-language name.

Examples

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

GetPrefDescId()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Integer GetPrefDescId()

Returns

Type	Description
Integer	Primary key.

Examples

NSPreferenceDescription thing;
Integer prefDescId = thing.GetPrefDescId();

GetRank()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Integer GetRank()

Returns

Type	Description
Integer	Rank field for ordering sections, and keys within sections.

Examples

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

GetRequiredLicense()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

String GetRequiredLicense()

Returns

Type	Description
String	Licenses the user/installation must have if this reference is to be shown. Comma-separated list of owner.module pairs.

Examples

NSPreferenceDescription thing;
String requiredLicense = thing.GetRequiredLicense();

GetSection()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

String GetSection()

Returns

Type	Description
String	Preference section name.

Examples

NSPreferenceDescription thing;
String section = thing.GetSection();

GetSubGroup()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

String GetSubGroup()

Returns

Type	Description
String	Keys that share a value (including NULL) in this field are shown together; a visual spacer is shown between groups.

Examples

NSPreferenceDescription thing;
String subGroup = thing.GetSubGroup();

GetSysMaxLevel()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Integer GetSysMaxLevel()

Returns

Type	Description
Integer	Lowest allowed setting level, set by SuperOffice. See PreferenceLevel

Examples

NSPreferenceDescription thing;
Integer sysMaxLevel = thing.GetSysMaxLevel();

GetTableName()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

String GetTableName()

Returns

Type	Description
String	If valueType = 5, then TableName contains the table referenced by the preference.

Examples

NSPreferenceDescription thing;
String tableName = thing.GetTableName();

GetUserDefinedListId()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Integer GetUserDefinedListId()

Returns

Type	Description
Integer	Read-only field, If valueType = 5, and TableName is UDList, then UserdefinedLIstId contains the ID of the list referenced by the preference.

Examples

NSPreferenceDescription thing;
Integer userDefinedListId = thing.GetUserDefinedListId();

GetValueType()

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Integer GetValueType()

Returns

Type	Description
Integer	See PrefDescValueType.

Examples

NSPreferenceDescription thing;
Integer valueType = thing.GetValueType();

SetAccessFlags(Integer)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetAccessFlags(Integer accessFlags)

Parameters

Type	Name	Description
Integer	accessFlags	See PrefDescAccessFlags.

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
Integer accessFlags;
thing.SetAccessFlags(accessFlags);

SetDescription(String)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetDescription(String description)

Parameters

Type	Name	Description
String	description	Description of preference, multi-language parsed.

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
String description;
thing.SetDescription(description);

SetIsBuiltin(Bool)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetIsBuiltin(Bool isBuiltin)

Parameters

Type	Name	Description
Bool	isBuiltin	1 = This row populated and maintained by SuperOffice.

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
Bool isBuiltin;
thing.SetIsBuiltin(isBuiltin);

SetKey(String)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetKey(String key)

Parameters

Type	Name	Description
String	key	Preference key name.

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
String key;
thing.SetKey(key);

SetMaxLevel(Integer)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetMaxLevel(Integer maxLevel)

Parameters

Type	Name	Description
Integer	maxLevel	Lowest allowed setting level, set by user, but not lower than sysMaxLevel. See PreferenceLevel.

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
Integer maxLevel;
thing.SetMaxLevel(maxLevel);

SetMaxValue(Integer)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetMaxValue(Integer maxValue)

Parameters

Type	Name	Description
Integer	maxValue	Max value (if type 1); list table ID (if type 5).

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
Integer maxValue;
thing.SetMaxValue(maxValue);

SetMinLevel(Integer)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetMinLevel(Integer minLevel)

Parameters

Type	Name	Description
Integer	minLevel	The minimum (furthest away from User) level this preference can be set for.

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
Integer minLevel;
thing.SetMinLevel(minLevel);

SetMinValue(Integer)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetMinValue(Integer minValue)

Parameters

Type	Name	Description
Integer	minValue	Min value (if type 1); list extra id (if type 5).

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
Integer minValue;
thing.SetMinValue(minValue);

SetName(String)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	Multi-language name.

Returns

Type	Description
Void

Examples

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

SetPrefDescId(Integer)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetPrefDescId(Integer prefDescId)

Parameters

Type	Name	Description
Integer	prefDescId	Primary key.

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
Integer prefDescId;
thing.SetPrefDescId(prefDescId);

SetRank(Integer)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetRank(Integer rank)

Parameters

Type	Name	Description
Integer	rank	Rank field for ordering sections, and keys within sections.

Returns

Type	Description
Void

Examples

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

SetRequiredLicense(String)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetRequiredLicense(String requiredLicense)

Parameters

Type	Name	Description
String	requiredLicense	Licenses the user/installation must have if this reference is to be shown. Comma-separated list of owner.module pairs.

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
String requiredLicense;
thing.SetRequiredLicense(requiredLicense);

SetSection(String)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetSection(String section)

Parameters

Type	Name	Description
String	section	Preference section name.

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
String section;
thing.SetSection(section);

SetSubGroup(String)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetSubGroup(String subGroup)

Parameters

Type	Name	Description
String	subGroup	Keys that share a value (including NULL) in this field are shown together; a visual spacer is shown between groups.

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
String subGroup;
thing.SetSubGroup(subGroup);

SetSysMaxLevel(Integer)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetSysMaxLevel(Integer sysMaxLevel)

Parameters

Type	Name	Description
Integer	sysMaxLevel	Lowest allowed setting level, set by SuperOffice. See PreferenceLevel.

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
Integer sysMaxLevel;
thing.SetSysMaxLevel(sysMaxLevel);

SetTableName(String)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetTableName(String tableName)

Parameters

Type	Name	Description
String	tableName	If valueType = 5, then TableName contains the table referenced by the preference.

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
String tableName;
thing.SetTableName(tableName);

SetUserDefinedListId(Integer)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetUserDefinedListId(Integer userDefinedListId)

Parameters

Type	Name	Description
Integer	userDefinedListId	Read-only field, If valueType = 5, and TableName is UDList, then UserdefinedLIstId contains the ID of the list referenced by the preference.

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
Integer userDefinedListId;
thing.SetUserDefinedListId(userDefinedListId);

SetValueType(Integer)

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Declaration

Void SetValueType(Integer valueType)

Parameters

Type	Name	Description
Integer	valueType	See PrefDescValueType.

Returns

Type	Description
Void

Examples

NSPreferenceDescription thing;
Integer valueType;
thing.SetValueType(valueType);