Skip to main content

Class Preference

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for Preference. One preference item, which contains a specification (section/key), the raw string value, and the level at which this value was found.

Inheritance

objectCarrierPreference

Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Constructors

Preference()

Default constructor - defaults any enum props to 0.

Properties

DisplayTooltip

Display tooltip, populated when asked for. Suitable for binding display-datasource in lists, etc. Formatted using CultureDataFormatter.

Property Value

string

DisplayType

Display type, populated when asked for. NULL if unknown enum value.

Property Value

PrefDescValueType?

See Also

Preference.DisplayType_String

DisplayType_String

Display type, populated when asked for. Raw string enum value.

Property Value

string

See Also

Preference.DisplayType

DisplayValue

Display value, populated when asked for. Suitable for binding display-datasource in lists, etc. Formatted using CultureDataFormatter.

Property Value

string

Level

Preference level, using the standard enumerated type. Undefined is returned for preferences that do not have a current setting. NULL if unknown enum value.

Property Value

PreferenceLevel?

See Also

Preference.Level_String

Level_String

Preference level, using the standard enumerated type. Undefined is returned for preferences that do not have a current setting. Raw string enum value.

Property Value

string

See Also

Preference.Level

PrefDescId

The id of the prefdesc this preference is connected to

Property Value

int

RawValue

Preference value

Property Value

string

Specification

Preference specification, consisting of the section name and key name

Property Value

PreferenceSpec

TabOrder

Property Value

TabOrder

TableName

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

Property Value

string

TargetId

The id of the target row. The table it points at is specified by the preference type.

Property Value

int

UserPreferenceId

The id of the user preference

Property Value

int

See Also

PreferenceAgent