Class PreferenceDescriptionLine
Preference description line, contains information about a single item in a preference description list.
Carrier object for PreferenceDescriptionLine. Services for the PreferenceDescriptionLine Carrier is available from the Preference Agent.
Namespace: SuperOfficeCRMServices
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.7.0.0")]
public class PreferenceDescriptionLine : Carrier
Examples
Get PreferenceDescriptionLine 123 using the agent:
using SuperOffice;
using SuperOffice.CRM.Services;
using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
var agent = new PreferenceAgent();
var preferenceDescriptionLine = agent.GetPreferenceDescriptionLine( 123 );
}
Constructors
PreferenceDescriptionLine()
Default constructor
Declaration
public PreferenceDescriptionLine()
Properties
Description
Description of preference value, multi-language parsed
Declaration
[DataMember]
public virtual string Description { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
IsBuiltin
1 = This row populated and maintained by SuperOffice
Declaration
[DataMember]
public virtual bool IsBuiltin { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
PrefDescId
Preference description (parent)
Declaration
[DataMember]
public virtual int PrefDescId { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
PrefDescLineId
Primary key
Declaration
[DataMember]
public virtual int PrefDescLineId { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
PrefShowValue
Descriptive value, multilang-parsed, to put in list
Declaration
[DataMember]
public virtual string PrefShowValue { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
PrefValue
Possible value
Declaration
[DataMember]
public virtual string PrefValue { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
ToString()
Returns the carrier contents as a formatted string.
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| string | The carrier contents. |
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. |