Class ArchiveColumnsProviderBase
This is the base class that translates the list of available columns of an Archive Provider into an MDO list suitable for feeding the archive configuration dialog. It is a generic provider in the sense that it handles all known archive providers (via the plugin factory); if any particular archive needs special treatment then code to do so should be added here.
This class has two derived classes, one for choosing display columns and one for choosing orderby columns. The difference is in the filtering of columns, and how the current configuration is merged in.
Inheritance
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
public abstract class ArchiveColumnsProviderBase : ArchiveConfigurationProviderBase, IDynamicMDOProvider, ISoListProvider, ISoList, IPlugin
Remarks
The AcceptColumn(ArchiveColumnInfo) and
Constructors
ArchiveColumnsProviderBase()
Constructor
Declaration
public ArchiveColumnsProviderBase()
Fields
_context
Declaration
protected string _context
Field Value
Type | Description |
---|---|
System.String |
_providerName
Declaration
protected string _providerName
Field Value
Type | Description |
---|---|
System.String |
Properties
InternalNamePrefix
Declaration
protected override string InternalNamePrefix { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
NamePrefix
The prefix used to differentiate our lists from all other MDO lists. To avoid naming collisions, if an archive is called
'activity' then the list we generate here will be called NamePrefix+'activity'.
Declaration
public static string NamePrefix { get; }
Property Value
Type | Description |
---|---|
System.String |
Methods
AcceptColumn(ArchiveColumnInfo)
This method will be called once for every available column of the underlying archive provider. By returning true, this method indicates that the column should be included as an item in the final MDO list.
Declaration
protected abstract bool AcceptColumn(ArchiveColumnInfo column)
Parameters
Type | Name | Description |
---|---|---|
ArchiveColumnInfo | column | Column information |
Returns
Type | Description |
---|---|
System.Boolean | true if column should be in constructed MDO list |
BuildItem(Int32, ArchiveColumnInfo)
Build an ISoListItem based on the column info
Declaration
protected virtual ISoListItem BuildItem(int id, ArchiveColumnInfo columnInfo)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | Unique ID to assign |
ArchiveColumnInfo | columnInfo | Column information |
Returns
Type | Description |
---|---|
ISoListItem | List item, including can order by indicator |
BuildList(String, String, String, Boolean)
This method is called during stage 2 of the two-phase construction process (from the
Declaration
protected override void BuildList(string providerName, string guiControl, string searchValue, bool forceFlatList)
Parameters
Type | Name | Description |
---|---|---|
System.String | providerName | |
System.String | guiControl | Name of GUI control, if provided by caller |
System.String | searchValue | Search value, if provided by caller |
System.Boolean | forceFlatList | Should the resulting list be forced to flat format (root items only) |