Class ArchiveRowProvider
MDO list based on an underlying Archive Provider and search value, which is applied to the first column. One such MDO list is offered for each ArchiveProvider plugin that is registered.
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists.Configuration_data_handling
Assembly: SoDataBase.dll
Syntax
[DynamicMDOProviderPlugin("Generic MDO list provider", 1073741823)]
public class ArchiveRowProvider : ArchiveConfigurationProviderBase, IDynamicMDOProvider, ISoListProvider, ISoList, IPlugin
Remarks
Items will contain concatenated values of the desired columns in the order they are given. Rows will be ordered by the first possible column. If a column is of type icon in the archive provider, it will be used for the icon hint instead of being part of the item name. Tooltips from all non-icon columns are concatenated to be the tooltip for the item.
A maximum ofConstructors
ArchiveRowProvider()
MDO list based on an underlying Archive Provider and search value, which is applied to the first column. One such MDO list is offered for each ArchiveProvider plugin that is registered.
Declaration
public ArchiveRowProvider()
Remarks
Items will contain concatenated values of the desired columns in the order they are given. Rows will be ordered by the first possible column. If a column is of type icon in the archive provider, it will be used for the icon hint instead of being part of the item name. Tooltips from all non-icon columns are concatenated to be the tooltip for the item.
A maximum ofFields
MAX_ITEMS
MDO list based on an underlying Archive Provider and search value, which is applied to the first column. One such MDO list is offered for each ArchiveProvider plugin that is registered.
Declaration
public const int MAX_ITEMS = 500
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Items will contain concatenated values of the desired columns in the order they are given. Rows will be ordered by the first possible column. If a column is of type icon in the archive provider, it will be used for the icon hint instead of being part of the item name. Tooltips from all non-icon columns are concatenated to be the tooltip for the item.
A maximum ofProperties
InternalNamePrefix
MDO list based on an underlying Archive Provider and search value, which is applied to the first column. One such MDO list is offered for each ArchiveProvider plugin that is registered.
Declaration
protected override string InternalNamePrefix { get; }
Property Value
Type | Description |
---|---|
String |
Overrides
Remarks
Items will contain concatenated values of the desired columns in the order they are given. Rows will be ordered by the first possible column. If a column is of type icon in the archive provider, it will be used for the icon hint instead of being part of the item name. Tooltips from all non-icon columns are concatenated to be the tooltip for the item.
A maximum ofNamePrefix
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 |
---|---|
String |
Remarks
Items will contain concatenated values of the desired columns in the order they are given. Rows will be ordered by the first possible column. If a column is of type icon in the archive provider, it will be used for the icon hint instead of being part of the item name. Tooltips from all non-icon columns are concatenated to be the tooltip for the item.
A maximum ofMethods
BuildList(String, String, String, Boolean)
Build the list based on the parameters. Currently only flat lists are built, though some infrastructure is in place to support hierarchical lists.
Declaration
protected override void BuildList(string providerName, string additionalInfo, string searchValue, bool forceFlatList)
Parameters
Type | Name | Description |
---|---|---|
String | providerName | Name of provider, must match an archive list |
String | additionalInfo | comma-separated column list, followed by the vertical bar |, followed by one or more
restrictions. Each restriction is formatted as a set of name/value pairs by the |
String | searchValue | Search value; if it is not null or empty, the first column from the provider must begin with this value |
Boolean | forceFlatList | Should a flat list be forced. |
Overrides
Remarks
Items will contain concatenated values of the desired columns in the order they are given. Rows will be ordered by the first possible column. If a column is of type icon in the archive provider, it will be used for the icon hint instead of being part of the item name. Tooltips from all non-icon columns are concatenated to be the tooltip for the item.
A maximum ofMakeAdditionalInfo(String[], ArchiveRestrictionInfo[])
Create a properly formatted 'additionalInfo' string from an array of column names and an array of restrictions
Declaration
public static string MakeAdditionalInfo(string[] columns, ArchiveRestrictionInfo[] restrictions)
Parameters
Type | Name | Description |
---|---|---|
String[] | columns | Column names, in the order they should be used in the resulting list |
ArchiveRestrictionInfo[] | restrictions | Restrictions to be passed on to the archive provider |
Returns
Type | Description |
---|---|
String | Properly formatted additionalInfo string |
Remarks
Items will contain concatenated values of the desired columns in the order they are given. Rows will be ordered by the first possible column. If a column is of type icon in the archive provider, it will be used for the icon hint instead of being part of the item name. Tooltips from all non-icon columns are concatenated to be the tooltip for the item.
A maximum ofMakeAdditionalInfo(String[], String, ArchiveRestrictionInfo[])
Create a properly formatted 'additionalInfo' string from an array of column names and an array of restrictions
Declaration
public static string MakeAdditionalInfo(string[] columns, string extraInfoColumn, ArchiveRestrictionInfo[] restrictions)
Parameters
Type | Name | Description |
---|---|---|
String[] | columns | Column names, in the order they should be used in the resulting list |
String | extraInfoColumn | Column to be returned in the extraInfo field of the items |
ArchiveRestrictionInfo[] | restrictions | Restrictions to be passed on to the archive provider |
Returns
Type | Description |
---|---|
String | Properly formatted additionalInfo string |
Remarks
Items will contain concatenated values of the desired columns in the order they are given. Rows will be ordered by the first possible column. If a column is of type icon in the archive provider, it will be used for the icon hint instead of being part of the item name. Tooltips from all non-icon columns are concatenated to be the tooltip for the item.
A maximum ofMergeInCurrentConfiguration(String, Object, String)
MDO list based on an underlying Archive Provider and search value, which is applied to the first column. One such MDO list is offered for each ArchiveProvider plugin that is registered.
Declaration
protected override void MergeInCurrentConfiguration(string guiName, object extraInfo, string ownerKeys)
Parameters
Type | Name | Description |
---|---|---|
String | guiName | |
Object | extraInfo | |
String | ownerKeys |
Overrides
Remarks
Items will contain concatenated values of the desired columns in the order they are given. Rows will be ordered by the first possible column. If a column is of type icon in the archive provider, it will be used for the icon hint instead of being part of the item name. Tooltips from all non-icon columns are concatenated to be the tooltip for the item.
A maximum of