Class ColumnHelper

This class is a helper that contains functionality for handling columns in an archive provider. It includes collections and methods for keeping track of available and chosen columns, determining whether any particular column is wanted, and the method that uses reflection to locate standard column declarations in client classes.

Inheritance

System.Object

ColumnHelper

Namespace: SuperOffice.CRM.ArchiveLists

Assembly: SoDataBase.dll

Syntax

public class ColumnHelper : Object

Constructors

ColumnHelper(IArchiveProviderHasColumns)

Construct the instance, set the owner (client) class reference

Declaration

public ColumnHelper(IArchiveProviderHasColumns owner)

Parameters

Type	Name	Description
IArchiveProviderHasColumns	owner

Fields

DefaultCheckboxWidth

Default width setting for columns of type checkbox

Declaration

public const string DefaultCheckboxWidth = "4c"

Field Value

Type	Description
System.String

DefaultDateTimeWidth

Default width setting for columns of type date

Declaration

public const string DefaultDateTimeWidth = "16c"

Field Value

Type	Description
System.String

DefaultDateWidth

Default width setting for columns of type date

Declaration

public const string DefaultDateWidth = "10c"

Field Value

Type	Description
System.String

DefaultDecimalWidth

Default width setting for columns of type decimal (floating-point)

Declaration

public const string DefaultDecimalWidth = "12c"

Field Value

Type	Description
System.String

DefaultIconWidth

Default width setting for columns of type icon

Declaration

public const string DefaultIconWidth = "3c"

Field Value

Type	Description
System.String

DefaultNumberWidth

Default width setting for columns of type number (integer)

Declaration

public const string DefaultNumberWidth = "8c"

Field Value

Type	Description
System.String

DefaultStringWidth

Default width setting for columns of type string

Declaration

public const string DefaultStringWidth = "10%"

Field Value

Type	Description
System.String

DefaultTimeWidth

Default width setting for columns of type decimal (floating-point)

Declaration

public const string DefaultTimeWidth = "5c"

Field Value

Type	Description
System.String

Properties

AvailableColumns

Get the current list of available columns as an array

Declaration

public List<ArchiveColumnInfo> AvailableColumns { get; }

Property Value

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

AvailableRestrictionColumns

Get the current list of available restriction columns as an array

Declaration

public List<ArchiveColumnInfo> AvailableRestrictionColumns { get; }

Property Value

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

Count

Get the number of currently known columns

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32

DesiredColumns

Current desired columns setting

Declaration

public string[] DesiredColumns { get; }

Property Value

Type	Description
System.String[]

DisplayNamePrefix

Current display name prefix

Declaration

public string DisplayNamePrefix { get; }

Property Value

Type	Description
System.String

NamePrefix

Current name prefix

Declaration

public string NamePrefix { get; }

Property Value

Type	Description
System.String

Methods

AddAvailableColumns(ArchiveColumnInfo[])

Add one or more columns to the list of available columns for this client class. If the column already exists, then let the new column disable OrderBy and RestrictBy if it does not support them.

Declaration

public void AddAvailableColumns(params ArchiveColumnInfo[] columns)

Parameters

Type	Name	Description
ArchiveColumnInfo[]	columns	One or more column information data blocks

AddAvailableColumns(Action<ArchiveColumnInfo, ArchiveColumnInfo>, ArchiveColumnInfo[])

Add one or more columns to the list of available columns for this client class. If the column already exists, the passed-in handler is called to deal with it

Declaration

public void AddAvailableColumns(Action<ArchiveColumnInfo, ArchiveColumnInfo> processDuplicates, params ArchiveColumnInfo[] columns)

Parameters

Type	Name	Description
System.Action<ArchiveColumnInfo, ArchiveColumnInfo>	processDuplicates	Method that gets the existing and the new column; any changes made to the existing column are what will be the final result
ArchiveColumnInfo[]	columns	One or more column information data blocks

AddAvailableColumnsAfter(String, ArchiveColumnInfo[])

Add one or more columns to the list of available columns for this client class. Add them right after the named column, if it exists, or at the end if it does not exist

Declaration

public void AddAvailableColumnsAfter(string addAfter, params ArchiveColumnInfo[] columns)

Parameters

Type	Name	Description
System.String	addAfter	Name of column to add new columns after
ArchiveColumnInfo[]	columns	One or more column information data blocks

AddAvailableColumnsBefore(String, ArchiveColumnInfo[])

Add one or more columns to the list of available columns for this client class. Add them right before the named column, if it exists, or at the end if it does not exist

Declaration

public void AddAvailableColumnsBefore(string addBefore, params ArchiveColumnInfo[] columns)

Parameters

Type	Name	Description
System.String	addBefore
ArchiveColumnInfo[]	columns	One or more column information data blocks

GetColumn(String)

Get a column from the available columns list, by full prefixed programmatic name

Declaration

public ArchiveColumnInfo GetColumn(string name)

Parameters

Type	Name	Description
System.String	name	Column to get

Returns

Type	Description
ArchiveColumnInfo	Column information, or null (no exception thrown) if the column does not exist

HasAvailableColumn(String)

Determine whether the given column (by programmatic name) is in the current available columns list

Declaration

public bool HasAvailableColumn(string name)

Parameters

Type	Name	Description
System.String	name	Programmatic column name to check

Returns

Type	Description
System.Boolean	true if the name matches an available column

RemoveAllAvailableColumns()

Remove all columns from the list of available columns for this client class

Declaration

public void RemoveAllAvailableColumns()

RemoveAvailableColumns(String[])

Remove one or more columns from the list of available columns for this client class

Declaration

public void RemoveAvailableColumns(params string[] columns)

Parameters

Type	Name	Description
System.String[]	columns	Names of columns to remove

RemoveDesiredColumns(String[])

Remove one or more columns from the list of desired columns

Declaration

public void RemoveDesiredColumns(params string[] columns)

Parameters

Type	Name	Description
System.String[]	columns	Names of columns to remove

SetAbsolutePrefixes(String, String)

Declaration

public void SetAbsolutePrefixes(string namePrefix, string displayNamePrefix)

Parameters

Type	Name	Description
System.String	namePrefix
System.String	displayNamePrefix

SetDesiredColumns(String[])

Set the desired columns, using an array of programmatic names. This will add to any currently chosen columns. Only columns that match our current list of available columns will be retained, other columns (that probably belong to other providers) will be quietly ignored. This behaviour is very much by design.

Declaration

public void SetDesiredColumns(string[] columnIds)

Parameters

Type	Name	Description
System.String[]	columnIds	Array of programmatic column names

SetIconHint(String)

Set the icon hint on all available columns that do not already have one; this will NOT force a column scan, so you can safely call from a base class

Declaration

public void SetIconHint(string iconHint)

Parameters

Type	Name	Description
System.String	iconHint	Iconhint to be set on all columns that have no iconhint yet

SetIconHint(String, ArchiveColumnInfo[])

Set the icon hint on all available columns that do not already have one; this WILL force a column scan, so call with care from base classes

Declaration

public void SetIconHint(string iconHint, params ArchiveColumnInfo[] columnsToSet)

Parameters

Type	Name	Description
System.String	iconHint	Iconhint to be set on all columns that have no iconhint yet
ArchiveColumnInfo[]	columnsToSet

SetPrefixes(String, String)

Set the programmatic name and display name prefixes (one or both)

Declaration

public void SetPrefixes(string namePrefix, string displayNamePrefix)

Parameters

Type	Name	Description
System.String	namePrefix	Name prefix to set, or null if no prefix is to be set
System.String	displayNamePrefix	Display name prefix to set, or null if no prefix is to be set

ToString()

Return a string suitable for debugging

Declaration

public override string ToString()

Returns

Type	Description
System.String

WantAnyColumn()

Determine whether ANY of our columns is in the desired columns list. This is a fast check, independent of the number of available or desired columns

Declaration

public bool WantAnyColumn()

Returns

Type	Description
System.Boolean	true if at least one column has been set as desired

WantAnyColumn(ArchiveColumnInfo[])

Determine whether at least one of the given columns is in the list of currently desired columns

Declaration

public bool WantAnyColumn(params ArchiveColumnInfo[] columns)

Parameters

Type	Name	Description
ArchiveColumnInfo[]	columns	Array of column information objects to check

Returns

Type	Description
System.Boolean	true if at least one of the names is in the desired column list, otherwise false

WantAnyColumn(String[])

Determine whether at least one of the given columns is in the list of currently desired columns

Declaration

public bool WantAnyColumn(params string[] names)

Parameters

Type	Name	Description
System.String[]	names	Array of programmatic names to check

Returns

Type	Description
System.Boolean	true if at least one of the names is in the desired column list, otherwise false

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)