Class RelatedDataFieldsProvider

Inheritance
object
RelatedDataFieldsProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOAdditionalInfo("table", "The name of the table to analyze for related fields", "ticket")]
[MDOAdditionalInfo("depth", "The recursion depth, default=1", "")]
[MDOProviderPlugin("RelatedDataFields")]
public class RelatedDataFieldsProvider : ISoListProvider, ISoList

Constructors

RelatedDataFieldsProvider()

Declaration
public RelatedDataFieldsProvider()

Fields

ProviderName

Declaration
public const string ProviderName = "RelatedDataFields"
Field Value
Type Description
string

Properties

HeadingItems

list of headings

Declaration
public List<ISoListHeading> HeadingItems { get; }
Property Value
Type Description
List<ISoListHeading>

HistoryInfo

History information for the supported list

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

HistoryItems

list of history items

Declaration
public List<ISoListItem> HistoryItems { get; }
Property Value
Type Description
List<ISoListItem>

RootItems

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

Declaration
public List<ISoListItem> RootItems { get; }
Property Value
Type Description
List<ISoListItem>

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

Implements

Extension Methods