Class Preference
One preference item, which contains a specification (section/key), the raw string value, and the level at which this value was found.
Carrier object for Preference. Services for the Preference Carrier is available from the Preference Agent.Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class Preference : CarrierConstructors
Preference()
Default constructor
Declaration
public Preference()See Also
Properties
DisplayTooltip
Display tooltip, populated when asked for. Suitable for binding display-datasource in lists, etc. Formatted using CultureDataFormatter.
Declaration
[DataMember]
public virtual string DisplayTooltip { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
DisplayType
Display type, populated when asked for.
Declaration
[DataMember]
public virtual PrefDescValueType DisplayType { get; set; }Property Value
| Type | Description |
|---|---|
| PrefDescValueType |
See Also
DisplayValue
Display value, populated when asked for. Suitable for binding display-datasource in lists, etc. Formatted using CultureDataFormatter.
Declaration
[DataMember]
public virtual string DisplayValue { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
Level
Preference level, using the standard enumerated type. Undefined is returned for preferences that do not have a current setting.
Declaration
[DataMember]
public virtual PreferenceLevel Level { get; set; }Property Value
| Type | Description |
|---|---|
| PreferenceLevel |
See Also
PrefDescId
The id of the prefdesc this preference is connected to
Declaration
[DataMember]
public virtual int PrefDescId { get; set; }Property Value
| Type | Description |
|---|---|
| int |
See Also
RawValue
Preference value
Declaration
[DataMember]
public virtual string RawValue { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
Specification
Preference specification, consisting of the section name and key name
Declaration
[DataMember]
public virtual PreferenceSpec Specification { get; set; }Property Value
| Type | Description |
|---|---|
| PreferenceSpec |
See Also
TabOrder
One preference item, which contains a specification (section/key), the raw string value, and the level at which this value was found.
Carrier object for Preference. Services for the Preference Carrier is available from the Preference Agent.Declaration
[DataMember]
public virtual TabOrder TabOrder { get; set; }Property Value
| Type | Description |
|---|---|
| TabOrder |
See Also
TableName
For DisplayType=PrefDescValueType.ListTableRef, TableName will contain the name of the table which the value reference to.
Declaration
[DataMember]
public virtual string TableName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
TargetId
The id of the target row. The table it points at is specified by the preference type.
Declaration
[DataMember]
public virtual int TargetId { get; set; }Property Value
| Type | Description |
|---|---|
| int |
See Also
UserPreferenceId
The id of the user preference
Declaration
[DataMember]
public virtual int UserPreferenceId { get; set; }Property Value
| Type | Description |
|---|---|
| int |
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. |