Class ArchiveListItem
Carrier object for ArchiveListItem. Services for the ArchiveListItem Carrier is available from the Archive Agent.
Namespace: SuperOfficeSuperOffice.CRMServices
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.7.0.0")]
public class ArchiveListItem : CarrierConstructors
ArchiveListItem()
Default constructor
Declaration
public ArchiveListItem()Properties
ColumnData
Dictionary of column name - column data items. Each column data item contains a display value, a tooltip hint, a link hint, and an orderby value. <para/>The display value is encoded by the CultureDataFormatter and can be decoded / localized by that class; all other values are optional. <para/>Tooltip hints can be passed to the TooltipProvider (Tooltip service) to be translated into an actual tootip.
Declaration
[DataMember]
public virtual ColumnDataDictionary ColumnData { get; set; }Property Value
| Type | Description |
|---|---|
| ColumnDataDictionary |
EntityName
The entity name of the ArchiveListItem. An ArchiveList may contain rows from different entities.
Declaration
[DataMember]
public virtual string EntityName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
LinkHint
Link hint for the row, indicating things like navigation links that can be presented as clickable hyperlinks
Declaration
[DataMember]
public virtual string LinkHint { get; set; }Property Value
| Type | Description |
|---|---|
| string |
PrimaryKey
The primary key for the row
Declaration
[DataMember]
public virtual int PrimaryKey { get; set; }Property Value
| Type | Description |
|---|---|
| int |
StyleHint
Style hint for the row, for instance 'retired' for associates or 'private' for appointments. Presentation layers can interpret the style hints as they see fit.
Declaration
[DataMember]
public virtual string StyleHint { 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. |