NSPreference - SuperOffice

One preference item, which contains a specification (section/key), the raw string value, and the level at which this value was found.

Constructors

NSPreference()

NSPreference

Initializes a new instance of the NSPreference class.

Methods

GetDisplayTooltip()

String GetDisplayTooltip()

Returns: CRMScript.Global.String - Display tooltip, populated when asked for. Formatted using CultureDataFormatter.

Suitable for binding display-datasource in lists, etc.

Example:

NSPreference thing;
String displayTooltip = thing.GetDisplayTooltip();

GetDisplayType()

Integer GetDisplayType()

Returns: CRMScript.Global.Integer - Display type, populated when asked for. See <xref href=“CRMScript.NetServer.PrefDescValueType” data-throw-if-not-resolved=“false”></xref>. Example:

NSPreference thing;
Integer displayType = thing.GetDisplayType();

GetDisplayValue()

String GetDisplayValue()

Returns: CRMScript.Global.String - Display value, populated when asked for. Formatted using CultureDataFormatter.

Suitable for binding display-datasource in lists, etc.

Example:

NSPreference thing;
String displayValue = thing.GetDisplayValue();

GetLevel()

Integer GetLevel()

Returns: CRMScript.Global.Integer - See <xref href=“CRMScript.NetServer.PreferenceLevel” data-throw-if-not-resolved=“false”></xref>. Undefined is returned for preferences that do not have a current setting. Example:

NSPreference thing;
Integer level = thing.GetLevel();

GetPrefDescId()

Integer GetPrefDescId()

Returns: CRMScript.Global.Integer - The ID of the prefdesc this preference is connected to. Example:

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

GetRawValue()

String GetRawValue()

Returns: CRMScript.Global.String - NSPreference value. Example:

NSPreference thing;
String rawValue = thing.GetRawValue();

GetSpecification()

NSPreferenceSpec GetSpecification()

Returns: CRMScript.NetServer.NSPreferenceSpec - Preference specification, consisting of the section name and key name. Example:

NSPreference thing;
NSPreferenceSpec specification = thing.GetSpecification();

GetTableName()

String GetTableName()

Returns: CRMScript.Global.String - For DisplayType=PrefDescValueType.ListTableRef, TableName will contain the name of the table which the value reference to. Example:

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

GetTabOrder()

NSTabOrder GetTabOrder()

Returns: CRMScript.NetServer.NSTabOrder Example:

NSPreference thing;
NSTabOrder tabOrder = thing.GetTabOrder();

GetTargetId()

Integer GetTargetId()

Returns: CRMScript.Global.Integer - The ID of the target row. The table it points at is specified by the preference type. Example:

NSPreference thing;
Integer targetId = thing.GetTargetId();

GetUserPreferenceId()

Integer GetUserPreferenceId()

Returns: CRMScript.Global.Integer - The ID of the user preference. Example:

NSPreference thing;
Integer userPreferenceId = thing.GetUserPreferenceId();

SetDisplayTooltip(String)

Void SetDisplayTooltip(String displayTooltip)

Returns: CRMScript.Global.Void

Suitable for binding display-datasource in lists, etc.

Example:

NSPreference thing;
String displayTooltip;
thing.SetDisplayTooltip(displayTooltip);

SetDisplayType(Integer)

Void SetDisplayType(Integer displayType)

Returns: CRMScript.Global.Void Example:

NSPreference thing;
Integer displayType;
thing.SetDisplayType(displayType);

SetDisplayValue(String)

Void SetDisplayValue(String displayValue)

Returns: CRMScript.Global.Void

Suitable for binding display-datasource in lists, etc.

Example:

NSPreference thing;
String displayValue;
thing.SetDisplayValue(displayValue);

SetLevel(Integer)

Void SetLevel(Integer level)

Returns: CRMScript.Global.Void

Undefined is returned for preferences that do not have a current setting.

Example:

NSPreference thing;
Integer level;
thing.SetLevel(level);

SetPrefDescId(Integer)

Void SetPrefDescId(Integer prefDescId)

Returns: CRMScript.Global.Void Example:

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

SetRawValue(String)

Void SetRawValue(String rawValue)

Returns: CRMScript.Global.Void Example:

NSPreference thing;
String rawValue;
thing.SetRawValue(rawValue);

SetSpecification(NSPreferenceSpec)

Void SetSpecification(NSPreferenceSpec specification)

Returns: CRMScript.Global.Void Example:

NSPreference thing;
NSPreferenceSpec specification;
thing.SetSpecification(specification);

SetTableName(String)

Void SetTableName(String tableName)

Returns: CRMScript.Global.Void Example:

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

SetTabOrder(NSTabOrder)

Void SetTabOrder(NSTabOrder tabOrder)

Returns: CRMScript.Global.Void Example:

NSPreference thing;
NSTabOrder tabOrder;
thing.SetTabOrder(tabOrder);

SetTargetId(Integer)

Void SetTargetId(Integer targetId)

Returns: CRMScript.Global.Void Example:

NSPreference thing;
Integer targetId;
thing.SetTargetId(targetId);

SetUserPreferenceId(Integer)

Void SetUserPreferenceId(Integer userPreferenceId)

Returns: CRMScript.Global.Void Example:

NSPreference thing;
Integer userPreferenceId;
thing.SetUserPreferenceId(userPreferenceId);

​Constructors

​NSPreference()

​Methods

​GetDisplayTooltip()

​GetDisplayType()

​GetDisplayValue()

​GetLevel()

​GetPrefDescId()

​GetRawValue()

​GetSpecification()

​GetTableName()

​GetTabOrder()

​GetTargetId()

​GetUserPreferenceId()

​SetDisplayTooltip(String)

​SetDisplayType(Integer)

​SetDisplayValue(String)

​SetLevel(Integer)

​SetPrefDescId(Integer)

​SetRawValue(String)

​SetSpecification(NSPreferenceSpec)

​SetTableName(String)

​SetTabOrder(NSTabOrder)

​SetTargetId(Integer)

​SetUserPreferenceId(Integer)

Constructors

NSPreference()

Methods

GetDisplayTooltip()

GetDisplayType()

GetDisplayValue()

GetLevel()

GetPrefDescId()

GetRawValue()

GetSpecification()

GetTableName()

GetTabOrder()

GetTargetId()

GetUserPreferenceId()

SetDisplayTooltip(String)

SetDisplayType(Integer)

SetDisplayValue(String)

SetLevel(Integer)

SetPrefDescId(Integer)

SetRawValue(String)

SetSpecification(NSPreferenceSpec)

SetTableName(String)

SetTabOrder(NSTabOrder)

SetTargetId(Integer)

SetUserPreferenceId(Integer)