Class PreferenceDescription

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

Carrier object for PreferenceDescription. Services for the PreferenceDescription Carrier is available from the Preference Agent.
Inheritance
object
PreferenceDescription
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class PreferenceDescription : Carrier
Examples

Get PreferenceDescription 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new PreferenceAgent();
   var preferenceDescription = agent.GetPreferenceDescription( 123 );
}

Constructors

PreferenceDescription()

Default constructor

Declaration
public PreferenceDescription()
See Also

Properties

AccessFlags

1=wizard mode, 2=level 0, 4=admin gui, 8=crm gui

Declaration
[DataMember]
public virtual PrefDescAccessFlags AccessFlags { get; set; }
Property Value
Type Description
PrefDescAccessFlags
See Also

Description

Description of preference, multi-language parsed

Declaration
[DataMember]
public virtual string Description { get; set; }
Property Value
Type Description
string
See Also

IsBuiltin

1 = This row populated and maintained by SuperOffice

Declaration
[DataMember]
public virtual bool IsBuiltin { get; set; }
Property Value
Type Description
bool
See Also

Key

Preference key name

Declaration
[DataMember]
public virtual string Key { get; set; }
Property Value
Type Description
string
See Also

MaxLevel

Lowest allowed setting level, set by user, but not lower than sysMaxLevel

Declaration
[DataMember]
public virtual PreferenceLevel MaxLevel { get; set; }
Property Value
Type Description
PreferenceLevel
See Also

MaxValue

Max value (if type 1); list table ID (if type 5)

Declaration
[DataMember]
public virtual int MaxValue { get; set; }
Property Value
Type Description
int
See Also

MinLevel

The minimum (furthest away from User) level this preference can be set for

Declaration
[DataMember]
public virtual int MinLevel { get; set; }
Property Value
Type Description
int
See Also

MinValue

Min value (if type 1); list extra id (if type 5)

Declaration
[DataMember]
public virtual int MinValue { get; set; }
Property Value
Type Description
int
See Also

Name

Multi-language name

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also

PrefDescId

Primary key

Declaration
[DataMember]
public virtual int PrefDescId { get; set; }
Property Value
Type Description
int
See Also

Rank

Rank field for ordering sections, and keys within sections

Declaration
[DataMember]
public virtual int Rank { get; set; }
Property Value
Type Description
int
See Also

RequiredLicense

Licenses the user/installation must have if this reference is to be shown. Comma-separated list of owner.module pairs

Declaration
[DataMember]
public virtual string RequiredLicense { get; set; }
Property Value
Type Description
string
See Also

Section

Preference section name

Declaration
[DataMember]
public virtual string Section { get; set; }
Property Value
Type Description
string
See Also

SubGroup

Keys that share a value (including NULL) in this field are shown together; a visual spacer is shown between groups

Declaration
[DataMember]
public virtual string SubGroup { get; set; }
Property Value
Type Description
string
See Also

SysMaxLevel

Lowest allowed setting level, set by SuperOffice

Declaration
[DataMember]
public virtual PreferenceLevel SysMaxLevel { get; set; }
Property Value
Type Description
PreferenceLevel
See Also

TableName

If valueType = 5, then TableName contains the table referenced by the preference

Declaration
[DataMember]
public virtual string TableName { get; set; }
Property Value
Type Description
string
See Also

UserDefinedListId

Read-only field, If valueType = 5, and TableName is UDList, then UserdefinedLIstId contains the id of the list referenced by the preference

Declaration
[DataMember]
public virtual int UserDefinedListId { get; set; }
Property Value
Type Description
int
See Also

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

Declaration
[DataMember]
public virtual PrefDescValueType ValueType { get; set; }
Property Value
Type Description
PrefDescValueType
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

See Also