Class NSPreference

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

Constructors

NSPreference()

Initializes a new instance of the NSPreference class.

Declaration

NSPreference

Methods

GetDisplayTooltip()

Declaration

String GetDisplayTooltip()

Examples

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

Returns

Type	Description
String	Display tooltip, populated when asked for. Formatted using CultureDataFormatter.

GetDisplayType()

Declaration

Integer GetDisplayType()

Examples

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

Returns

Type	Description
Integer	Display type, populated when asked for. See <xref href="CRMScript.NetServer.PrefDescValueType" data-throw-if-not-resolved="false"></xref>.

GetDisplayValue()

Declaration

String GetDisplayValue()

Examples

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

Returns

Type	Description
String	Display value, populated when asked for. Formatted using CultureDataFormatter.

GetLevel()

Declaration

Integer GetLevel()

Examples

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

Returns

Type	Description
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.

GetPrefDescId()

Declaration

Integer GetPrefDescId()

Examples

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

Returns

Type	Description
Integer	The ID of the prefdesc this preference is connected to.

GetRawValue()

Declaration

String GetRawValue()

Examples

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

Returns

Type	Description
String	NSPreference value.

GetSpecification()

Declaration

NSPreferenceSpec GetSpecification()

Examples

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

Returns

Type	Description
NSPreferenceSpec	Preference specification, consisting of the section name and key name.

GetTableName()

Declaration

String GetTableName()

Examples

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

Returns

Type	Description
String	For DisplayType=PrefDescValueType.ListTableRef, TableName will contain the name of the table which the value reference to.

GetTabOrder()

Declaration

NSTabOrder GetTabOrder()

Examples

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

Returns

Type	Description
NSTabOrder

GetTargetId()

Declaration

Integer GetTargetId()

Examples

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

Returns

Type	Description
Integer	The ID of the target row. The table it points at is specified by the preference type.

GetUserPreferenceId()

Declaration

Integer GetUserPreferenceId()

Examples

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

Returns

Type	Description
Integer	The ID of the user preference.

SetDisplayTooltip(String)

Declaration

Void SetDisplayTooltip(String displayTooltip)

Examples

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

Parameters

Type	Name	Description
String	displayTooltip	Display tooltip, populated when asked for. Formatted using CultureDataFormatter.

Returns

Type	Description
Void

SetDisplayType(Integer)

Declaration

Void SetDisplayType(Integer displayType)

Examples

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

Parameters

Type	Name	Description
Integer	displayType	Display type, populated when asked for. See <xref href="CRMScript.NetServer.PrefDescValueType" data-throw-if-not-resolved="false"></xref>.

Returns

Type	Description
Void

SetDisplayValue(String)

Declaration

Void SetDisplayValue(String displayValue)

Examples

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

Parameters

Type	Name	Description
String	displayValue	Display value, populated when asked for. Formatted using CultureDataFormatter.

Returns

Type	Description
Void

SetLevel(Integer)

Declaration

Void SetLevel(Integer level)

Examples

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

Parameters

Type	Name	Description
Integer	level	Preference level. See <xref href="CRMScript.NetServer.PreferenceLevel" data-throw-if-not-resolved="false"></xref>.

Returns

Type	Description
Void

SetPrefDescId(Integer)

Declaration

Void SetPrefDescId(Integer prefDescId)

Examples

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

Parameters

Type	Name	Description
Integer	prefDescId	The ID of the prefdesc this preference is connected to.

Returns

Type	Description
Void

SetRawValue(String)

Declaration

Void SetRawValue(String rawValue)

Examples

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

Parameters

Type	Name	Description
String	rawValue	Preference value.

Returns

Type	Description
Void

SetSpecification(NSPreferenceSpec)

Declaration

Void SetSpecification(NSPreferenceSpec specification)

Examples

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

Parameters

Type	Name	Description
NSPreferenceSpec	specification	Preference specification, consisting of the section name and key name.

Returns

Type	Description
Void

SetTableName(String)

Declaration

Void SetTableName(String tableName)

Examples

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

Parameters

Type	Name	Description
String	tableName	For DisplayType=PrefDescValueType.ListTableRef, TableName will contain the name of the table which the value reference to.

Returns

Type	Description
Void

SetTabOrder(NSTabOrder)

Declaration

Void SetTabOrder(NSTabOrder tabOrder)

Examples

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

Parameters

Type	Name	Description
NSTabOrder	tabOrder

Returns

Type	Description
Void

SetTargetId(Integer)

Declaration

Void SetTargetId(Integer targetId)

Examples

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

Parameters

Type	Name	Description
Integer	targetId	The ID of the target row. The table it points at is specified by the preference type.

Returns

Type	Description
Void

SetUserPreferenceId(Integer)

Declaration

Void SetUserPreferenceId(Integer userPreferenceId)

Examples

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

Parameters

Type	Name	Description
Integer	userPreferenceId	The ID of the user preference.

Returns

Type	Description
Void