NSPreferenceDescription

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

Constructors

NSPreferenceDescription()

NSPreferenceDescription

Initializes a new instance of the NSPreferenceDescription class.

Methods

GetAccessFlags()

Integer GetAccessFlags()

Returns: CRMScript.Global.Integer - See <xref href=“CRMScript.NetServer.PrefDescAccessFlags” data-throw-if-not-resolved=“false”></xref>. Example:

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

GetDescription()

String GetDescription()

Returns: CRMScript.Global.String - Description of preference, multi-language parsed. Example:

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

GetIsBuiltin()

Bool GetIsBuiltin()

Returns: CRMScript.Global.Bool - 1 = This row populated and maintained by SuperOffice. Example:

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

GetKey()

String GetKey()

Returns: CRMScript.Global.String - Preference key name. Example:

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

GetMaxLevel()

Integer GetMaxLevel()

Returns: CRMScript.Global.Integer - Lowest allowed setting level, set by user, but not lower than enum <xref href=“CRMScript.NetServer.PreferenceLevel” data-throw-if-not-resolved=“false”></xref> Example:

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

GetMaxValue()

Integer GetMaxValue()

Returns: CRMScript.Global.Integer - Max value (if type 1); list table ID (if type 5). Example:

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

GetMinLevel()

Integer GetMinLevel()

Returns: CRMScript.Global.Integer - The minimum (furthest away from User) level this preference can be set for. Example:

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

GetMinValue()

Integer GetMinValue()

Returns: CRMScript.Global.Integer - Min value (if type 1); list extra id (if type 5). Example:

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

GetName()

String GetName()

Returns: CRMScript.Global.String - Multi-language name. Example:

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

GetPrefDescId()

Integer GetPrefDescId()

Returns: CRMScript.Global.Integer - Primary key. Example:

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

GetRank()

Integer GetRank()

Returns: CRMScript.Global.Integer - Rank field for ordering sections, and keys within sections. Example:

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

GetRequiredLicense()

String GetRequiredLicense()

Returns: CRMScript.Global.String - Licenses the user/installation must have if this reference is to be shown. Comma-separated list of owner.module pairs. Example:

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

GetSection()

String GetSection()

Returns: CRMScript.Global.String - Preference section name. Example:

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

GetSubGroup()

String GetSubGroup()

Returns: CRMScript.Global.String - Keys that share a value (including NULL) in this field are shown together; a visual spacer is shown between groups. Example:

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

GetSysMaxLevel()

Integer GetSysMaxLevel()

Returns: CRMScript.Global.Integer - Lowest allowed setting level, set by SuperOffice. See <xref href=“CRMScript.NetServer.PreferenceLevel” data-throw-if-not-resolved=“false”></xref> Example:

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

GetTableName()

String GetTableName()

Returns: CRMScript.Global.String - If valueType = 5, then TableName contains the table referenced by the preference. Example:

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

GetUserDefinedListId()

Integer GetUserDefinedListId()

Returns: CRMScript.Global.Integer - Read-only field, If valueType = 5, and TableName is UDList, then UserdefinedLIstId contains the ID of the list referenced by the preference. Example:

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

GetValueType()

Integer GetValueType()

Returns: CRMScript.Global.Integer - See <xref href=“CRMScript.NetServer.PrefDescValueType” data-throw-if-not-resolved=“false”></xref>. Example:

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

SetAccessFlags(Integer)

Void SetAccessFlags(Integer accessFlags)

Returns: CRMScript.Global.Void Example:

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

SetDescription(String)

Void SetDescription(String description)

Returns: CRMScript.Global.Void Example:

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

SetIsBuiltin(Bool)

Void SetIsBuiltin(Bool isBuiltin)

Returns: CRMScript.Global.Void Example:

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

SetKey(String)

Void SetKey(String key)

Returns: CRMScript.Global.Void Example:

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

SetMaxLevel(Integer)

Void SetMaxLevel(Integer maxLevel)

Returns: CRMScript.Global.Void Example:

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

SetMaxValue(Integer)

Void SetMaxValue(Integer maxValue)

Returns: CRMScript.Global.Void Example:

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

SetMinLevel(Integer)

Void SetMinLevel(Integer minLevel)

Returns: CRMScript.Global.Void Example:

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

SetMinValue(Integer)

Void SetMinValue(Integer minValue)

Returns: CRMScript.Global.Void Example:

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

SetName(String)

Void SetName(String name)

Returns: CRMScript.Global.Void Example:

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

SetPrefDescId(Integer)

Void SetPrefDescId(Integer prefDescId)

Returns: CRMScript.Global.Void Example:

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

SetRank(Integer)

Void SetRank(Integer rank)

Returns: CRMScript.Global.Void Example:

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

SetRequiredLicense(String)

Void SetRequiredLicense(String requiredLicense)

Returns: CRMScript.Global.Void Example:

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

SetSection(String)

Void SetSection(String section)

Returns: CRMScript.Global.Void Example:

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

SetSubGroup(String)

Void SetSubGroup(String subGroup)

Returns: CRMScript.Global.Void Example:

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

SetSysMaxLevel(Integer)

Void SetSysMaxLevel(Integer sysMaxLevel)

Returns: CRMScript.Global.Void Example:

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

SetTableName(String)

Void SetTableName(String tableName)

Returns: CRMScript.Global.Void Example:

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

SetUserDefinedListId(Integer)

Void SetUserDefinedListId(Integer userDefinedListId)

Returns: CRMScript.Global.Void Example:

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

SetValueType(Integer)

Void SetValueType(Integer valueType)

Returns: CRMScript.Global.Void Example:

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

​Constructors

​NSPreferenceDescription()

​Methods

​GetAccessFlags()

​GetDescription()

​GetIsBuiltin()

​GetKey()

​GetMaxLevel()

​GetMaxValue()

​GetMinLevel()

​GetMinValue()

​GetName()

​GetPrefDescId()

​GetRank()

​GetRequiredLicense()

​GetSection()

​GetSubGroup()

​GetSysMaxLevel()

​GetTableName()

​GetUserDefinedListId()

​GetValueType()

​SetAccessFlags(Integer)

​SetDescription(String)

​SetIsBuiltin(Bool)

​SetKey(String)

​SetMaxLevel(Integer)

​SetMaxValue(Integer)

​SetMinLevel(Integer)

​SetMinValue(Integer)

​SetName(String)

​SetPrefDescId(Integer)

​SetRank(Integer)

​SetRequiredLicense(String)

​SetSection(String)

​SetSubGroup(String)

​SetSysMaxLevel(Integer)

​SetTableName(String)

​SetUserDefinedListId(Integer)

​SetValueType(Integer)

Constructors

NSPreferenceDescription()

Methods

GetAccessFlags()

GetDescription()

GetIsBuiltin()

GetKey()

GetMaxLevel()

GetMaxValue()

GetMinLevel()

GetMinValue()

GetName()

GetPrefDescId()

GetRank()

GetRequiredLicense()

GetSection()

GetSubGroup()

GetSysMaxLevel()

GetTableName()

GetUserDefinedListId()

GetValueType()

SetAccessFlags(Integer)

SetDescription(String)

SetIsBuiltin(Bool)

SetKey(String)

SetMaxLevel(Integer)

SetMaxValue(Integer)

SetMinLevel(Integer)

SetMinValue(Integer)

SetName(String)

SetPrefDescId(Integer)

SetRank(Integer)

SetRequiredLicense(String)

SetSection(String)

SetSubGroup(String)

SetSysMaxLevel(Integer)

SetTableName(String)

SetUserDefinedListId(Integer)

SetValueType(Integer)