Skip to main content

​
Class ArchiveColumnInfo

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for ArchiveColumnInfo. This class carries information about the definition and properties of an archive display column. It is used by the archive MDO providers to construct column lists for the configuration dialogs, and by the archive control to know what type (and other properties) each column has. The class is serializable and used on both the application and Web server sides.

​
Inheritance

object ← ArchiveColumnInfo

​
Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

​
Constructors

​
ArchiveColumnInfo()

Default constructor - defaults any enum props to 0.

​
Properties

​
CanOrderBy

Can this column be used for sorting?

​
Property Value

bool

​
CanRestrictBy

Can this column be used as a restriction

​
Property Value

bool

​
DisplayName

The column name to show, can be a resource identifier string.

​
Property Value

string

​
DisplayTooltip

The column tooltip, used in the column list and in the column headings

​
Property Value

string

​
DisplayType

Type of column, so that the archive knows how to display it (actual display values are always strings, invariant-culture formatted). This name can contain resource tags.

​
Property Value

string

​
ExtraInfo

Example: ‘navigator’ -> Should this column be mapped to a hyperlinked navigator text type?

​
Property Value

string

​
HeadingIconHint

Icon hint for the archive heading only. If this is a nonempty string, the archive header should use this icon and ignore the DisplayName. Otherwise, the DisplayName should be used as the heading.

​
Property Value

string

​
IconHint

Icon hint corresponding to the display name; this icon hint is used in the configuration dialog and other places where we ‘talk about’ the columns of the archive. The actual heading of the archive may also contain icons in lieu of textual names, the icon hint for that is specified in HeadingIconHint and is a different one.

​
Property Value

string

​
IsVisible

Is this column visible to the user in configuration dialogs etc

​
Property Value

bool

​
Name

Unique identity of this column (in this particular context); the name to be used when requesting the column from a provider, setting restrictions or order by criteria

​
Property Value

string

​
RestrictionListName

If the restriction data type is ‘list’, this property contains the name of the SoList so that choices can be shown

​
Property Value

string

​
RestrictionType

The data type of the restriction; use this to retrieve the legal operators for the restriction.

​
Property Value

string

​
Width

The width specification, if the column info has been extended with GUI-based information. It is either “n%” or “nc”, where n is an integer. Percent-formatted fields grow and shrink; number-of-characters formatted fields have constant width when the whole archive width changes.

​
Property Value

string

​
See Also

ArchiveAgent

Related topics

How to create a user-defined field using the web services APIWebAPI changes in SuperOffice 12.0WebAPI changes in SuperOffice 12.2WebAPI changes in SuperOffice 12.1SuperOffice WebApiGet Default Order By From Desired ColumnsGet Default Order By