Class ListWithNoSelectionProvider

Dynamic list provider that 'wraps around' all existing lists, adding a (No selection) item with ID 0 in front of the first 'real' item in the inner list. The generated list name is the inner name plus the WithNoSelection suffix.

Inheritance
object
ListWithNoSelectionProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[DynamicMDOProviderPlugin("NoSelectionWrapper", 2147483647)]
public class ListWithNoSelectionProvider : IDynamicMDOProvider, ISoListProvider, ISoList
Remarks

This list provider has priority int.MaxValue; it will always come last, so its name suffix will always be the last in the actual list name.

Constructors

ListWithNoSelectionProvider()

Dynamic list provider that 'wraps around' all existing lists, adding a (No selection) item with ID 0 in front of the first 'real' item in the inner list. The generated list name is the inner name plus the WithNoSelection suffix.

Declaration
public ListWithNoSelectionProvider()
Remarks

This list provider has priority int.MaxValue; it will always come last, so its name suffix will always be the last in the actual list name.

Fields

NoSelectionResource

Dynamic list provider that 'wraps around' all existing lists, adding a (No selection) item with ID 0 in front of the first 'real' item in the inner list. The generated list name is the inner name plus the WithNoSelection suffix.

Declaration
public const string NoSelectionResource = "[SR_NO_SELECTION]"
Field Value
Type Description
string
Remarks

This list provider has priority int.MaxValue; it will always come last, so its name suffix will always be the last in the actual list name.

Suffix

Dynamic list provider that 'wraps around' all existing lists, adding a (No selection) item with ID 0 in front of the first 'real' item in the inner list. The generated list name is the inner name plus the WithNoSelection suffix.

Declaration
public const string Suffix = "WithNoSelection"
Field Value
Type Description
string
Remarks

This list provider has priority int.MaxValue; it will always come last, so its name suffix will always be the last in the actual list name.

Properties

HistoryInfo

History information for the supported list

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

This list provider has priority int.MaxValue; it will always come last, so its name suffix will always be the last in the actual list name.

SupportedLists

Return information about all supported lists

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

This list provider has priority int.MaxValue; it will always come last, so its name suffix will always be the last in the actual list name.

Methods

ClearHistoryItems()

Clears the history items

Declaration
public void ClearHistoryItems()
Remarks

This list provider has priority int.MaxValue; it will always come last, so its name suffix will always be the last in the actual list name.

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

Phase two of two-stage list construction. To be called right after the constructor, at which point all constructors have run, and the class hierarchy is initialized.

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

List name (though note that as implemented by MDOProviderBase, this actually has to be a real table name, so subclasses should override and convert from their list name to a real table name) (yes it's a bit messy)
string additionalInfo

Additional information to provider
int[] historyIDs

Array of history ID's; if non-null, this will BE the history; a non-null but empty array will disable reading of history altogether; a null parameter will cause history to be read from the database.
bool onlyReadHistory

if true, only history will be read.
string searchValue

If non-null, the returned list will be flat and only consist of search matches
bool forceFlatList

If true, the returned list will be flat, though it will still be filtered if grouping/filtering has been set up for the list
CancellationToken cancellationToken
Returns
Type Description
Task
Remarks

This list provider has priority int.MaxValue; it will always come last, so its name suffix will always be the last in the actual list name.

GetHeadingItemsAsync(CancellationToken)

list of 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; it will always come last, so its name suffix will always be the last in the actual list name.

GetHistoryItemsAsync(CancellationToken)

list of 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; it will always come last, so its name suffix will always be the last in the actual list name.

GetRootItemsAsync(CancellationToken)

list of root-level items (items not under any heading)

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; it will always come last, so its name suffix will always be the last in the actual list name.

Implements

Extension Methods