Skip to main content

​
Class ArchiveListItem

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for ArchiveListItem.

​
Inheritance

object ← Carrier ← ArchiveListItem

​
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()

​
Constructors

​
ArchiveListItem()

Default constructor - defaults any enum props to 0.

​
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.

​
Property Value

ColumnDataDictionary

​
EntityName

The entity name of the ArchiveListItem. An ArchiveList may contain rows from different entities.

​
Property Value

string

​
LinkHint

Link hint for the row, indicating things like navigation links that can be presented as clickable hyperlinks

​
Property Value

string

​
PrimaryKey

The primary key for the row

​
Property Value

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.

​
Property Value

string

​
See Also

ArchiveAgent

Related topics

SuperOffice.WebApi.Data.ArchiveListResultSuperOffice.WebApi.Agents.ArchiveAgentSuperOffice.WebApi.Agents.IArchiveAgentSuperOffice.WebApi.Data.FindResultsSuperOffice.WebApi.Data.CriteriaInformationSuperOffice.WebApi.Agents.ISelectionAgent