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.
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[DynamicMDOProviderPlugin("NoSelectionWrapper", 2147483647)]
public class ListWithNoSelectionProvider : IDynamicMDOProvider, ISoListProvider, ISoListRemarks
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.
Properties
HeadingItems
list of headings
Declaration
public List<ISoListHeading> HeadingItems { get; }Property Value
| Type | Description |
|---|---|
| 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.
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.
HistoryItems
list of history items
Declaration
public List<ISoListItem> HistoryItems { get; }Property Value
| Type | Description |
|---|---|
| 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.
RootItems
list of root-level items (items not under any heading)
Declaration
public List<ISoListItem> RootItems { get; }Property Value
| Type | Description |
|---|---|
| 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.
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 static string Suffix { get; }Property 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.
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
Construct(string, string, int[], bool, string, bool)
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 void Construct(string listName, string additionalInfo, int[] historyIDs, bool onlyReadHistory, string searchValue, bool forceFlatList)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 |
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.