Class NSPreferenceDescriptionLine
Preference description line, contains information about a single item in a preference description list.
Syntax
Constructors
NSPreferenceDescriptionLine()
Initializes a new instance of the NSPreferenceDescriptionLine class.
Declaration
NSPreferenceDescriptionLine
Methods
GetDescription()
Preference description line, contains information about a single item in a preference description list.
Declaration
String GetDescription()
Returns
Type | Description |
---|---|
String | Description of preference value, multi-language parsed. |
Examples
NSPreferenceDescriptionLine thing;
String description = thing.GetDescription();
GetIsBuiltin()
Preference description line, contains information about a single item in a preference description list.
Declaration
Bool GetIsBuiltin()
Returns
Type | Description |
---|---|
Bool | 1 = This row populated and maintained by SuperOffice. |
Examples
NSPreferenceDescriptionLine thing;
Bool isBuiltin = thing.GetIsBuiltin();
GetPrefDescId()
Preference description line, contains information about a single item in a preference description list.
Declaration
Integer GetPrefDescId()
Returns
Type | Description |
---|---|
Integer | Preference description (parent). |
Examples
NSPreferenceDescriptionLine thing;
Integer prefDescId = thing.GetPrefDescId();
GetPrefDescLineId()
Preference description line, contains information about a single item in a preference description list.
Declaration
Integer GetPrefDescLineId()
Returns
Type | Description |
---|---|
Integer | Primary key. |
Examples
NSPreferenceDescriptionLine thing;
Integer prefDescLineId = thing.GetPrefDescLineId();
GetPrefShowValue()
Preference description line, contains information about a single item in a preference description list.
Declaration
String GetPrefShowValue()
Returns
Type | Description |
---|---|
String | Descriptive value, multilang-parsed, to put in list. |
Examples
NSPreferenceDescriptionLine thing;
String prefShowValue = thing.GetPrefShowValue();
GetPrefValue()
Preference description line, contains information about a single item in a preference description list.
Declaration
String GetPrefValue()
Returns
Type | Description |
---|---|
String | Possible value. |
Examples
NSPreferenceDescriptionLine thing;
String prefValue = thing.GetPrefValue();
SetDescription(String)
Preference description line, contains information about a single item in a preference description list.
Declaration
Void SetDescription(String description)
Parameters
Type | Name | Description |
---|---|---|
String | description | Description of preference value, multi-language parsed. |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceDescriptionLine thing;
String description;
thing.SetDescription(description);
SetIsBuiltin(Bool)
Preference description line, contains information about a single item in a preference description list.
Declaration
Void SetIsBuiltin(Bool isBuiltin)
Parameters
Type | Name | Description |
---|---|---|
Bool | isBuiltin | 1 = This row populated and maintained by SuperOffice. |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceDescriptionLine thing;
Bool isBuiltin;
thing.SetIsBuiltin(isBuiltin);
SetPrefDescId(Integer)
Preference description line, contains information about a single item in a preference description list.
Declaration
Void SetPrefDescId(Integer prefDescId)
Parameters
Type | Name | Description |
---|---|---|
Integer | prefDescId | Preference description (parent). |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceDescriptionLine thing;
Integer prefDescId;
thing.SetPrefDescId(prefDescId);
SetPrefDescLineId(Integer)
Preference description line, contains information about a single item in a preference description list.
Declaration
Void SetPrefDescLineId(Integer prefDescLineId)
Parameters
Type | Name | Description |
---|---|---|
Integer | prefDescLineId | Primary key. |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceDescriptionLine thing;
Integer prefDescLineId;
thing.SetPrefDescLineId(prefDescLineId);
SetPrefShowValue(String)
Preference description line, contains information about a single item in a preference description list.
Declaration
Void SetPrefShowValue(String prefShowValue)
Parameters
Type | Name | Description |
---|---|---|
String | prefShowValue | Descriptive value, multilang-parsed, to put in list. |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceDescriptionLine thing;
String prefShowValue;
thing.SetPrefShowValue(prefShowValue);
SetPrefValue(String)
Preference description line, contains information about a single item in a preference description list.
Declaration
Void SetPrefValue(String prefValue)
Parameters
Type | Name | Description |
---|---|---|
String | prefValue | Possible value. |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceDescriptionLine thing;
String prefValue;
thing.SetPrefValue(prefValue);