Class ListWithAllItemProvider

MDO list wrapper that extends existing lists with an "All" entry. "All" entry will return id = -2

Inheritance
object
ListWithAllItemProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[DynamicMDOProviderPlugin("AllItemWrapper", 2147483637)]
public class ListWithAllItemProvider : IDynamicMDOProvider, ISoListProvider, ISoList
Remarks

This list provider has priority int.MaxValue - 10, so it comes after the HeadingsAsItemsProvider and before the ListWithNoSelectionProvider.

Constructors

ListWithAllItemProvider()

MDO list wrapper that extends existing lists with an "All" entry. "All" entry will return id = -2

Declaration
public ListWithAllItemProvider()
Remarks

This list provider has priority int.MaxValue - 10, so it comes after the HeadingsAsItemsProvider and before the ListWithNoSelectionProvider.

Properties

HistoryInfo

Returns ...

Declaration
public HistoryInfo HistoryInfo { get; }
Property Value
Type Description
HistoryInfo
Remarks

This list provider has priority int.MaxValue - 10, so it comes after the HeadingsAsItemsProvider and before the ListWithNoSelectionProvider.

Suffix

The magic extension name to invoke this wrapper

Declaration
public static string Suffix { get; }
Property Value
Type Description
string
Remarks

This list provider has priority int.MaxValue - 10, so it comes after the HeadingsAsItemsProvider and before the ListWithNoSelectionProvider.

SupportedLists

MDO list wrapper that extends existing lists with an "All" entry. "All" entry will return id = -2

Declaration
public HistoryInfo[] SupportedLists { get; }
Property Value
Type Description
HistoryInfo[]
Remarks

This list provider has priority int.MaxValue - 10, so it comes after the HeadingsAsItemsProvider and before the ListWithNoSelectionProvider.

Methods

ClearHistoryItems()

Clears the history items

Declaration
public void ClearHistoryItems()
Remarks

This list provider has priority int.MaxValue - 10, so it comes after the HeadingsAsItemsProvider and before the ListWithNoSelectionProvider.

ConstructAsync(string, string, int[], bool, string, bool, CancellationToken)

Pass creation on to the "real" list

Declaration
public Task ConstructAsync(string listName, string additionalInfo, int[] historyIDs, bool onlyReadHistory, string searchValue, bool forceFlatList, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string listName
string additionalInfo
int[] historyIDs
bool onlyReadHistory
string searchValue
bool forceFlatList
CancellationToken cancellationToken
Returns
Type Description
Task
Remarks

This list provider has priority int.MaxValue - 10, so it comes after the HeadingsAsItemsProvider and before the ListWithNoSelectionProvider.

GetHeadingItemsAsync(CancellationToken)

Return headings

Declaration
public Task<List<ISoListHeading>> GetHeadingItemsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<List<ISoListHeading>>
Remarks

This list provider has priority int.MaxValue - 10, so it comes after the HeadingsAsItemsProvider and before the ListWithNoSelectionProvider.

GetHistoryItemsAsync(CancellationToken)

Return all history items

Declaration
public Task<List<ISoListItem>> GetHistoryItemsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<List<ISoListItem>>
Remarks

This list provider has priority int.MaxValue - 10, so it comes after the HeadingsAsItemsProvider and before the ListWithNoSelectionProvider.

GetRootItemsAsync(CancellationToken)

Return all items including our custom entries

Declaration
public Task<List<ISoListItem>> GetRootItemsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<List<ISoListItem>>
Remarks

This list provider has priority int.MaxValue - 10, so it comes after the HeadingsAsItemsProvider and before the ListWithNoSelectionProvider.

Implements

Extension Methods