Class NSPreferenceDescription
Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.
Constructors
NSPreferenceDescription()
Initializes a new instance of the NSPreferenceDescription class.
Declaration
NSPreferenceDescriptionMethods
GetAccessFlags()
Declaration
Integer GetAccessFlags()Examples
NSPreferenceDescription thing;
Integer accessFlags = thing.GetAccessFlags();Returns
| Type | Description |
| Integer | See <xref href="CRMScript.NetServer.PrefDescAccessFlags" data-throw-if-not-resolved="false"></xref>. |
GetDescription()
Declaration
String GetDescription()Examples
NSPreferenceDescription thing;
String description = thing.GetDescription();Returns
| Type | Description |
| String | Description of preference, multi-language parsed. |
GetIsBuiltin()
Declaration
Bool GetIsBuiltin()Examples
NSPreferenceDescription thing;
Bool isBuiltin = thing.GetIsBuiltin();Returns
| Type | Description |
| Bool | 1 = This row populated and maintained by SuperOffice. |
GetKey()
Declaration
String GetKey()Examples
NSPreferenceDescription thing;
String key = thing.GetKey();Returns
| Type | Description |
| String | Preference key name. |
GetMaxLevel()
Declaration
Integer GetMaxLevel()Examples
NSPreferenceDescription thing;
Integer maxLevel = thing.GetMaxLevel();Returns
| Type | Description |
| 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> |
GetMaxValue()
Declaration
Integer GetMaxValue()Examples
NSPreferenceDescription thing;
Integer maxValue = thing.GetMaxValue();Returns
| Type | Description |
| Integer | Max value (if type 1); list table ID (if type 5). |
GetMinLevel()
Declaration
Integer GetMinLevel()Examples
NSPreferenceDescription thing;
Integer minLevel = thing.GetMinLevel();Returns
| Type | Description |
| Integer | The minimum (furthest away from User) level this preference can be set for. |
GetMinValue()
Declaration
Integer GetMinValue()Examples
NSPreferenceDescription thing;
Integer minValue = thing.GetMinValue();Returns
| Type | Description |
| Integer | Min value (if type 1); list extra id (if type 5). |
GetName()
Declaration
String GetName()Examples
NSPreferenceDescription thing;
String name = thing.GetName();Returns
| Type | Description |
| String | Multi-language name. |
GetPrefDescId()
Declaration
Integer GetPrefDescId()Examples
NSPreferenceDescription thing;
Integer prefDescId = thing.GetPrefDescId();Returns
| Type | Description |
| Integer | Primary key. |
GetRank()
Declaration
Integer GetRank()Examples
NSPreferenceDescription thing;
Integer rank = thing.GetRank();Returns
| Type | Description |
| Integer | Rank field for ordering sections, and keys within sections. |
GetRequiredLicense()
Declaration
String GetRequiredLicense()Examples
NSPreferenceDescription thing;
String requiredLicense = thing.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. |
GetSection()
Declaration
String GetSection()Examples
NSPreferenceDescription thing;
String section = thing.GetSection();Returns
| Type | Description |
| String | Preference section name. |
GetSubGroup()
Declaration
String GetSubGroup()Examples
NSPreferenceDescription thing;
String subGroup = thing.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. |
GetSysMaxLevel()
Declaration
Integer GetSysMaxLevel()Examples
NSPreferenceDescription thing;
Integer sysMaxLevel = thing.GetSysMaxLevel();Returns
| Type | Description |
| Integer | Lowest allowed setting level, set by SuperOffice. See <xref href="CRMScript.NetServer.PreferenceLevel" data-throw-if-not-resolved="false"></xref> |
GetTableName()
Declaration
String GetTableName()Examples
NSPreferenceDescription thing;
String tableName = thing.GetTableName();Returns
| Type | Description |
| String | If valueType = 5, then TableName contains the table referenced by the preference. |
GetUserDefinedListId()
Declaration
Integer GetUserDefinedListId()Examples
NSPreferenceDescription thing;
Integer userDefinedListId = thing.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. |
GetValueType()
Declaration
Integer GetValueType()Examples
NSPreferenceDescription thing;
Integer valueType = thing.GetValueType();Returns
| Type | Description |
| Integer | See <xref href="CRMScript.NetServer.PrefDescValueType" data-throw-if-not-resolved="false"></xref>. |
SetAccessFlags(Integer)
Declaration
Void SetAccessFlags(Integer accessFlags)Examples
NSPreferenceDescription thing;
Integer accessFlags;
thing.SetAccessFlags(accessFlags);Parameters
| Type | Name | Description |
| Integer | accessFlags | See <xref href="CRMScript.NetServer.PrefDescAccessFlags" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetDescription(String)
Declaration
Void SetDescription(String description)Examples
NSPreferenceDescription thing;
String description;
thing.SetDescription(description);Parameters
| Type | Name | Description |
| String | description | Description of preference, multi-language parsed. |
Returns
| Type | Description |
| Void |
SetIsBuiltin(Bool)
Declaration
Void SetIsBuiltin(Bool isBuiltin)Examples
NSPreferenceDescription thing;
Bool isBuiltin;
thing.SetIsBuiltin(isBuiltin);Parameters
| Type | Name | Description |
| Bool | isBuiltin | 1 = This row populated and maintained by SuperOffice. |
Returns
| Type | Description |
| Void |
SetKey(String)
Declaration
Void SetKey(String key)Examples
NSPreferenceDescription thing;
String key;
thing.SetKey(key);Parameters
| Type | Name | Description |
| String | key | Preference key name. |
Returns
| Type | Description |
| Void |
SetMaxLevel(Integer)
Declaration
Void SetMaxLevel(Integer maxLevel)Examples
NSPreferenceDescription thing;
Integer maxLevel;
thing.SetMaxLevel(maxLevel);Parameters
| Type | Name | Description |
| Integer | maxLevel | Lowest allowed setting level, set by user, but not lower than sysMaxLevel. See <xref href="CRMScript.NetServer.PreferenceLevel" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetMaxValue(Integer)
Declaration
Void SetMaxValue(Integer maxValue)Examples
NSPreferenceDescription thing;
Integer maxValue;
thing.SetMaxValue(maxValue);Parameters
| Type | Name | Description |
| Integer | maxValue | Max value (if type 1); list table ID (if type 5). |
Returns
| Type | Description |
| Void |
SetMinLevel(Integer)
Declaration
Void SetMinLevel(Integer minLevel)Examples
NSPreferenceDescription thing;
Integer minLevel;
thing.SetMinLevel(minLevel);Parameters
| Type | Name | Description |
| Integer | minLevel | The minimum (furthest away from User) level this preference can be set for. |
Returns
| Type | Description |
| Void |
SetMinValue(Integer)
Declaration
Void SetMinValue(Integer minValue)Examples
NSPreferenceDescription thing;
Integer minValue;
thing.SetMinValue(minValue);Parameters
| Type | Name | Description |
| Integer | minValue | Min value (if type 1); list extra id (if type 5). |
Returns
| Type | Description |
| Void |
SetName(String)
Declaration
Void SetName(String name)Examples
NSPreferenceDescription thing;
String name;
thing.SetName(name);Parameters
| Type | Name | Description |
| String | name | Multi-language name. |
Returns
| Type | Description |
| Void |
SetPrefDescId(Integer)
Declaration
Void SetPrefDescId(Integer prefDescId)Examples
NSPreferenceDescription thing;
Integer prefDescId;
thing.SetPrefDescId(prefDescId);Parameters
| Type | Name | Description |
| Integer | prefDescId | Primary key. |
Returns
| Type | Description |
| Void |
SetRank(Integer)
Declaration
Void SetRank(Integer rank)Examples
NSPreferenceDescription thing;
Integer rank;
thing.SetRank(rank);Parameters
| Type | Name | Description |
| Integer | rank | Rank field for ordering sections, and keys within sections. |
Returns
| Type | Description |
| Void |
SetRequiredLicense(String)
Declaration
Void SetRequiredLicense(String requiredLicense)Examples
NSPreferenceDescription thing;
String requiredLicense;
thing.SetRequiredLicense(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 |
SetSection(String)
Declaration
Void SetSection(String section)Examples
NSPreferenceDescription thing;
String section;
thing.SetSection(section);Parameters
| Type | Name | Description |
| String | section | Preference section name. |
Returns
| Type | Description |
| Void |
SetSubGroup(String)
Declaration
Void SetSubGroup(String subGroup)Examples
NSPreferenceDescription thing;
String subGroup;
thing.SetSubGroup(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 |
SetSysMaxLevel(Integer)
Declaration
Void SetSysMaxLevel(Integer sysMaxLevel)Examples
NSPreferenceDescription thing;
Integer sysMaxLevel;
thing.SetSysMaxLevel(sysMaxLevel);Parameters
| Type | Name | Description |
| Integer | sysMaxLevel | Lowest allowed setting level, set by SuperOffice. See <xref href="CRMScript.NetServer.PreferenceLevel" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetTableName(String)
Declaration
Void SetTableName(String tableName)Examples
NSPreferenceDescription thing;
String tableName;
thing.SetTableName(tableName);Parameters
| Type | Name | Description |
| String | tableName | If valueType = 5, then TableName contains the table referenced by the preference. |
Returns
| Type | Description |
| Void |
SetUserDefinedListId(Integer)
Declaration
Void SetUserDefinedListId(Integer userDefinedListId)Examples
NSPreferenceDescription thing;
Integer userDefinedListId;
thing.SetUserDefinedListId(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 |
SetValueType(Integer)
Declaration
Void SetValueType(Integer valueType)Examples
NSPreferenceDescription thing;
Integer valueType;
thing.SetValueType(valueType);Parameters
| Type | Name | Description |
| Integer | valueType | See <xref href="CRMScript.NetServer.PrefDescValueType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |