Class PreferenceDescription
Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for PreferenceDescription.
Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.
Inheritance
object ←
Carrier ←
PreferenceDescription
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()
Examples
Get PreferenceDescription 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new PreferenceAgent(configuration);
var preferenceDescription = agent.GetPreferenceDescription( 123 );
Constructors
PreferenceDescription()
Default constructor - defaults any enum props to 0.
Properties
AccessFlags
1=wizard mode, 2=level 0, 4=admin gui, 8=crm gui
NULL if unknown enum value.
Property Value
PrefDescAccessFlags?
See Also
PreferenceDescription.AccessFlags_String
AccessFlags_String
1=wizard mode, 2=level 0, 4=admin gui, 8=crm gui
Raw string enum value.
Property Value
string
See Also
PreferenceDescription.AccessFlags
Description
Description of preference, multi-language parsed
Property Value
string
IsBuiltin
1 = This row populated and maintained by SuperOffice
Property Value
bool
Key
Preference key name
Property Value
string
MaxLevel
Lowest allowed setting level, set by user, but not lower than sysMaxLevel
NULL if unknown enum value.
Property Value
PreferenceLevel?
See Also
PreferenceDescription.MaxLevel_String
MaxLevel_String
Lowest allowed setting level, set by user, but not lower than sysMaxLevel
Raw string enum value.
Property Value
string
See Also
PreferenceDescription.MaxLevel
MaxValue
Max value (if type 1); list table ID (if type 5)
Property Value
int
MinLevel
The minimum (furthest away from User) level this preference can be set for
Property Value
int
MinValue
Min value (if type 1); list extra id (if type 5)
Property Value
int
Name
Multi-language name
Property Value
string
PrefDescId
Primary key
Property Value
int
Rank
Rank field for ordering sections, and keys within sections
Property Value
int
RequiredLicense
Licenses the user/installation must have if this reference is to be shown. Comma-separated list of owner.module pairs
Property Value
string
Section
Preference section name
Property Value
string
SubGroup
Keys that share a value (including NULL) in this field are shown together; a visual spacer is shown between groups
Property Value
string
SysMaxLevel
Lowest allowed setting level, set by SuperOffice
NULL if unknown enum value.
Property Value
PreferenceLevel?
See Also
PreferenceDescription.SysMaxLevel_String
SysMaxLevel_String
Lowest allowed setting level, set by SuperOffice
Raw string enum value.
Property Value
string
See Also
PreferenceDescription.SysMaxLevel
TableName
If valueType = 5, then TableName contains the table referenced by the preference
Property Value
string
UserDefinedListId
Read-only field, If valueType = 5, and TableName is UDList, then UserdefinedLIstId contains the id of the list referenced by the preference
Property Value
int
ValueType
1=number, 2=text, 3=bool, 4=list of values; 5=list table ref; 6=contact ID, 7=Person ID, 8=Project ID, 9=Selection ID
NULL if unknown enum value.
Property Value
PrefDescValueType?
See Also
PreferenceDescription.ValueType_String
ValueType_String
1=number, 2=text, 3=bool, 4=list of values; 5=list table ref; 6=contact ID, 7=Person ID, 8=Project ID, 9=Selection ID
Raw string enum value.
Property Value
string
See Also
PreferenceDescription.ValueType
See Also
PreferenceAgent
