Class 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

System.Object

ArchiveColumnInfo

Implements

System.ICloneable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: SuperOffice.CRM.ArchiveLists

Assembly: SoCore.dll

Syntax

public sealed class ArchiveColumnInfo : ICloneable

Constructors

ArchiveColumnInfo()

Construct the object, not setting anything.

Declaration

public ArchiveColumnInfo()

ArchiveColumnInfo(String, String, String)

Construct the object, setting name, display name and type only

Declaration

public ArchiveColumnInfo(string name, string displayName, string displayType)

Parameters

Type	Name	Description
System.String	name	Programmatic unique name
System.String	displayName	User-visible display name
System.String	displayType	Column type, such as 'string', 'int', 'icon' etc

ArchiveColumnInfo(String, String, String, String, Boolean, Boolean, String)

Construct the object, setting almost all fields. This constructor is suitable for all fields that are not restrictable lists or icons. For fields that can be used as restrictions, consider using the constructor that has the additional restrictionType and restrictionListName arguments, giving full control of the information.

Declaration

public ArchiveColumnInfo(string name, string displayName, string displayTooltip, string displayType, bool canOrderBy, bool isVisible, string width)

Parameters

Type	Name	Description
System.String	name	Programmatic unique name
System.String	displayName	User-visible display name
System.String	displayTooltip	Tooltip to be displayed when the user hovers over the field name in column lists
System.String	displayType	Column type, such as 'string', 'int', 'icon' etc
Boolean	canOrderBy	True if this field can be used in the order by list
Boolean	isVisible	True if this field should be visible in the archive configuration dialogs
System.String	width	Default or current width setting

ArchiveColumnInfo(String, String, String, String, Boolean, Boolean, String, String)

Construct the object, setting all fields. This constructor is suitable for fields that can be used as restrictions. It has the additional restrictionType and restrictionListName arguments, giving full control of the information.

Declaration

public ArchiveColumnInfo(string name, string displayName, string displayTooltip, string displayType, bool canOrderBy, bool isVisible, string width, string restrictionType)

Parameters

Type	Name	Description
System.String	name	Programmatic unique name
System.String	displayName	User-visible display name
System.String	displayTooltip	Tooltip to be displayed when the user hovers over the field name in column lists
System.String	displayType	Column type, such as 'string', 'int', 'icon' etc
Boolean	canOrderBy	True if this field can be used in the order by list
Boolean	isVisible	True if this field should be visible in the archive configuration dialogs
System.String	width	Default or current width setting
System.String	restrictionType	Data type for restrictions

ArchiveColumnInfo(String, String, String, String, Boolean, Boolean, String, String, String)

Construct the object, setting all fields. This constructor is suitable for fields that can be used as restrictions. It has the additional restrictionType and restrictionListName arguments, giving full control of the information.

Declaration

public ArchiveColumnInfo(string name, string displayName, string displayTooltip, string displayType, bool canOrderBy, bool isVisible, string width, string restrictionType, string restrictionListName)

Parameters

Type	Name	Description
System.String	name	Programmatic unique name
System.String	displayName	User-visible display name
System.String	displayTooltip	Tooltip to be displayed when the user hovers over the field name in column lists
System.String	displayType	Column type, such as 'string', 'int', 'icon' etc
Boolean	canOrderBy	True if this field can be used in the order by list
Boolean	isVisible	True if this field should be visible in the archive configuration dialogs
System.String	width	Default or current width setting
System.String	restrictionType	Data type for restrictions
System.String	restrictionListName	Name of list

Fields

__sourceCode

Declaration

public string __sourceCode

Field Value

Type	Description
System.String

Properties

BaseName

Base part of the unique identity of this column, i.e., Name stripped of any prefixes. Note that this may no longer be unique. This property is read only.

Declaration

public string BaseName { get; }

Property Value

Type	Description
System.String

CanOrderBy

Can this column be used for sorting?

Declaration

public bool CanOrderBy { get; set; }

Property Value

Type	Description
Boolean

CanRestrictBy

Can this column be used as a restriction

Declaration

public bool CanRestrictBy { get; set; }

Property Value

Type	Description
Boolean

DisplayName

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

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
System.String

DisplayNamePrefixDelimiter

The delimiter used between components of a prefixed display name (what the user sees)

Declaration

public static string DisplayNamePrefixDelimiter { get; }

Property Value

Type	Description
System.String

DisplayTooltip

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

Declaration

public string DisplayTooltip { get; set; }

Property Value

Type	Description
System.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.

Declaration

public string DisplayType { get; set; }

Property Value

Type	Description
System.String

ExtraInfo

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

Declaration

public string ExtraInfo { get; set; }

Property Value

Type	Description
System.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.

Declaration

public string HeadingIconHint { get; set; }

Property Value

Type	Description
System.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.

Declaration

public string IconHint { get; set; }

Property Value

Type	Description
System.String

IsVisible

Is this column visible to the user in configuration dialogs etc

Declaration

public bool IsVisible { get; set; }

Property Value

Type	Description
Boolean

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

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

NamePrefixDelimiter

The delimiter used between components of a prefixed name

Declaration

public static string NamePrefixDelimiter { get; }

Property Value

Type	Description
System.String

RestrictionListName

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

Declaration

public string RestrictionListName { get; set; }

Property Value

Type	Description
System.String

RestrictionType

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

Declaration

public string RestrictionType { get; set; }

Property Value

Type	Description
System.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.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String

Methods

AddPrefixToDisplayName(String, String)

Add a prefix to a column name, using the DisplayNamePrefixDelimiter

Declaration

public static string AddPrefixToDisplayName(string name, string prefix)

Parameters

Type	Name	Description
System.String	name	Name to add a prefix to
System.String	prefix	Prefix, may be null or empty

Returns

Type	Description
System.String	Prefixed name

AddPrefixToName(String, String)

Add a prefix to a column name, using the NamePrefixDelimiter

Declaration

public static string AddPrefixToName(string name, string prefix)

Parameters

Type	Name	Description
System.String	name	Name to add a prefix to
System.String	prefix	Prefix, may be null or empty

Returns

Type	Description
System.String	Prefixed name

AssociateColumn(String, String, String)

Declaration

public static ArchiveColumnInfo AssociateColumn(string name, string displayName, string width = "8c")

Parameters

Type	Name	Description
System.String	name
System.String	displayName
System.String	width

Returns

Type	Description
ArchiveColumnInfo

AssociateFullNameColumn(String, String, String)

Declaration

public static ArchiveColumnInfo AssociateFullNameColumn(string name, string displayName, string width = "20%")

Parameters

Type	Name	Description
System.String	name
System.String	displayName
System.String	width

Returns

Type	Description
ArchiveColumnInfo

CheckBoxColumn(String, String, String)

Declaration

public static ArchiveColumnInfo CheckBoxColumn(string name, string displayName, string width = "4c")

Parameters

Type	Name	Description
System.String	name
System.String	displayName
System.String	width

Returns

Type	Description
ArchiveColumnInfo

Clone()

Declaration

public object Clone()

Returns

Type	Description
System.Object

DateColumn(String, String, String)

Declaration

public static ArchiveColumnInfo DateColumn(string name, string displayName, string width = "10c")

Parameters

Type	Name	Description
System.String	name
System.String	displayName
System.String	width

Returns

Type	Description
ArchiveColumnInfo

DateTimeColumn(String, String, String)

Declaration

public static ArchiveColumnInfo DateTimeColumn(string name, string displayName, string width = "16c")

Parameters

Type	Name	Description
System.String	name
System.String	displayName
System.String	width

Returns

Type	Description
ArchiveColumnInfo

DecimalColumn(String, String, String)

Declaration

public static ArchiveColumnInfo DecimalColumn(string name, string displayName, string width = "12c")

Parameters

Type	Name	Description
System.String	name
System.String	displayName
System.String	width

Returns

Type	Description
ArchiveColumnInfo

ExtractBaseName(String)

Get the base name of a column name (not display name)

Declaration

public static string ExtractBaseName(string name)

Parameters

Type	Name	Description
System.String	name	Name to process

Returns

Type	Description
System.String	base name, i.e., without all prefixes

ExtractCompletePrefix(String)

Extract the prefix from a column name. If there is no prefix, the empty string is returned. If there are multiple prefixes, one long string comprising everything except the base name is returned.

Declaration

public static string ExtractCompletePrefix(string name)

Parameters

Type	Name	Description
System.String	name	Name to process, can be null or empty

Returns

Type	Description
System.String	Empty string, or prefix. String may contain NamePrefixDelimiter but will not end with it

IntColumn(String, String, String)

Declaration

public static ArchiveColumnInfo IntColumn(string name, string displayName, string width = "8c")

Parameters

Type	Name	Description
System.String	name
System.String	displayName
System.String	width

Returns

Type	Description
ArchiveColumnInfo

IsDotSyntax()

Declaration

public bool IsDotSyntax()

Returns

Type	Description
Boolean

IsDotSyntax(String[])

Declaration

public static bool IsDotSyntax(params string[] columnName)

Parameters

Type	Name	Description
System.String[]	columnName

Returns

Type	Description
Boolean

NormalizeColumnPercentWidths(List<ArchiveColumnInfo>)

Normalize the percent widths of a list of columns

Declaration

public static void NormalizeColumnPercentWidths(List<ArchiveColumnInfo> retVal)

Parameters

Type	Name	Description
System.Collections.Generic.List<ArchiveColumnInfo>	retVal

PrefixBy(String, String)

Add the given prefix(es) to the name and displayname. You can prefix either the name, displayname, both or none.

Declaration

public void PrefixBy(string namePrefix, string displayNamePrefix)

Parameters

Type	Name	Description
System.String	namePrefix	Prefix for column (internal) name, or null if it should not be prefixed
System.String	displayNamePrefix	Prefix for display name, or null if it should not be prefixed

RegisteredByColumn()

Declaration

public static ArchiveColumnInfo RegisteredByColumn()

Returns

Type	Description
ArchiveColumnInfo

RegisteredDateColumn()

Declaration

public static ArchiveColumnInfo RegisteredDateColumn()

Returns

Type	Description
ArchiveColumnInfo

RemovePrefix(String, String)

Remove the given prefix(es) from the name and displayname, if present. You can remove either a name prefix, a display name prefix, both or none. No exceptions are thrown.

Declaration

public void RemovePrefix(string namePrefix, string displayNamePrefix)

Parameters

Type	Name	Description
System.String	namePrefix	Internal name prefix to remove; will be removed if it is the front of the current name
System.String	displayNamePrefix	Display name prefix to remove; will be removed if it is the front of the current name

StringColumn(String, String, String)

Declaration

public static ArchiveColumnInfo StringColumn(string name, string displayName, string width = "10c")

Parameters

Type	Name	Description
System.String	name
System.String	displayName
System.String	width

Returns

Type	Description
ArchiveColumnInfo

ToNameArray(ArchiveColumnInfo[])

Utility method to convert an array of ArchiveColumnInfo into a string array containing the names only

Declaration

public static string[] ToNameArray(params ArchiveColumnInfo[] columnInfos)

Parameters

Type	Name	Description
ArchiveColumnInfo[]	columnInfos	Column infos to extract names from

Returns

Type	Description
System.String[]	Array of names, in original order

ToNameArray(List<ArchiveColumnInfo>)

Utility method to convert a list of ArchiveColumnInfo into a string array containing the names only

Declaration

public static string[] ToNameArray(List<ArchiveColumnInfo> columnInfos)

Parameters

Type	Name	Description
System.Collections.Generic.List<ArchiveColumnInfo>	columnInfos	Column infos to extract names from

Returns

Type	Description
System.String[]	Array of names, in original order

ToNameArray(Predicate<ArchiveColumnInfo>, ArchiveColumnInfo[])

Utility method to conditionally convert an array of ArchiveColumnInfo into a string array containing the names only. The given predicate is applied to each ArchiveColumnInfo to determine if its name should be included in the result.

Declaration

public static string[] ToNameArray(Predicate<ArchiveColumnInfo> condition, params ArchiveColumnInfo[] columnInfos)

Parameters

Type	Name	Description
System.Predicate<ArchiveColumnInfo>	condition	Predicate that takes an ArchiveColumnInfo and returns a bool. A value of true indicates that that particular ArchiveColumnInfo should be included in the result.
ArchiveColumnInfo[]	columnInfos	Column infos to test and extract the name from

Returns

Type	Description
System.String[]	Array of names of column infos that were chosen, in original order

ToNameArray(Predicate<ArchiveColumnInfo>, List<ArchiveColumnInfo>)

Utility method to conditionally convert a list of ArchiveColumnInfo into a string array containing the names only. The given predicate is applied to each ArchiveColumnInfo to determine if its name should be included in the result.

Declaration

public static string[] ToNameArray(Predicate<ArchiveColumnInfo> condition, List<ArchiveColumnInfo> columnInfos)

Parameters

Type	Name	Description
System.Predicate<ArchiveColumnInfo>	condition	Predicate that takes an ArchiveColumnInfo and returns a bool. A value of true indicates that that particular ArchiveColumnInfo should be included in the result.
System.Collections.Generic.List<ArchiveColumnInfo>	columnInfos	Column infos to test and extract the name from

Returns

Type	Description
System.String[]	Array of names of column infos that were chosen, in original order

ToNameDictionary(ArchiveColumnInfo[])

Utility method to convert an array of ArchiveColumnInfo into a string array containing the names only

Declaration

public static Dictionary<string, ArchiveColumnInfo> ToNameDictionary(params ArchiveColumnInfo[] columnInfos)

Parameters

Type	Name	Description
ArchiveColumnInfo[]	columnInfos	Column infos to extract names from

Returns

Type	Description
System.Collections.Generic.Dictionary<System.String, ArchiveColumnInfo>	Array of names, in original order

ToNameDictionary(List<ArchiveColumnInfo>)

Utility method to convert a list of ArchiveColumnInfo into a string array containing the names only

Declaration

public static Dictionary<string, ArchiveColumnInfo> ToNameDictionary(List<ArchiveColumnInfo> columnInfos)

Parameters

Type	Name	Description
System.Collections.Generic.List<ArchiveColumnInfo>	columnInfos	Column infos to extract names from

Returns

Type	Description
System.Collections.Generic.Dictionary<System.String, ArchiveColumnInfo>	Array of names, in original order

ToNameDictionary(Predicate<ArchiveColumnInfo>, ArchiveColumnInfo[])

Utility method to conditionally convert an array of ArchiveColumnInfo into a string array containing the names only. The given predicate is applied to each ArchiveColumnInfo to determine if its name should be included in the result.

Declaration

public static Dictionary<string, ArchiveColumnInfo> ToNameDictionary(Predicate<ArchiveColumnInfo> condition, params ArchiveColumnInfo[] columnInfos)

Parameters

Type	Name	Description
System.Predicate<ArchiveColumnInfo>	condition	Predicate that takes an ArchiveColumnInfo and returns a bool. A value of true indicates that that particular ArchiveColumnInfo should be included in the result.
ArchiveColumnInfo[]	columnInfos	Column infos to test and extract the name from

Returns

Type	Description
System.Collections.Generic.Dictionary<System.String, ArchiveColumnInfo>	Array of names of column infos that were chosen, in original order

ToNameDictionary(Predicate<ArchiveColumnInfo>, List<ArchiveColumnInfo>)

Utility method to conditionally convert a list of ArchiveColumnInfo into a string array containing the names only. The given predicate is applied to each ArchiveColumnInfo to determine if its name should be included in the result.

Declaration

public static Dictionary<string, ArchiveColumnInfo> ToNameDictionary(Predicate<ArchiveColumnInfo> condition, List<ArchiveColumnInfo> columnInfos)

Parameters

Type	Name	Description
System.Predicate<ArchiveColumnInfo>	condition	Predicate that takes an ArchiveColumnInfo and returns a bool. A value of true indicates that that particular ArchiveColumnInfo should be included in the result.
System.Collections.Generic.List<ArchiveColumnInfo>	columnInfos	Column infos to test and extract the name from

Returns

Type	Description
System.Collections.Generic.Dictionary<System.String, ArchiveColumnInfo>	Array of names of column infos that were chosen, in original order

ToString()

Returns a string representation of most of the column data, intended for debugging display use

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

ToString(String)

Declaration

public string ToString(string prefix)

Parameters

Type	Name	Description
System.String	prefix

Returns

Type	Description
System.String

UpdatedByColumn()

Declaration

public static ArchiveColumnInfo UpdatedByColumn()

Returns

Type	Description
ArchiveColumnInfo

UpdatedDateColumn()

Declaration

public static ArchiveColumnInfo UpdatedDateColumn()

Returns

Type	Description
ArchiveColumnInfo

Implements

System.ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)

ObjectExtensions.AssignByReflection<T>(T, T)

ObjectExtensions.GraphCopy<T>(T)

ConnectorExtensions.GetFieldMetadataTypeInfo(ArchiveColumnInfo)

ConnectorExtensions.GetListName(ArchiveColumnInfo)

ConnectorExtensions.ToMetadataInfo(ArchiveColumnInfo)

Converters.MapEnums<From, To>(From)