Class RelationListProvider
MDO list provider for contact/person relation definitions. This provider is a takes a mandatory additionalInfo parameter, that specifies what kind of relation should be fetched.
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("ContactRelationDefinition")]
[MDOAdditionalInfo("RelationType enum value. CC=Contact-Contact relations", "CC")]
public class RelationListProvider : MDOProviderBase, ISoListProvider, ISoList, IEnumerable<ISoListItem>, IEnumerableRemarks
AdditionalInfo can be one of 'CC', 'CP', 'PC', 'PP', specifying contact or person on the source and destination sides of the relation. A join is made to the relationTarget table to pick out the correct relation definitions to show. The RelationListProvider.RelationType enum can be used to avoid strings when specifying the relation type.
The extraInfo field in the items contains the passive (reverse) text, useful for display.Constructors
RelationListProvider()
MDO list provider for contact/person relation definitions. This provider is a takes a mandatory additionalInfo parameter, that specifies what kind of relation should be fetched.
Declaration
public RelationListProvider()Remarks
AdditionalInfo can be one of 'CC', 'CP', 'PC', 'PP', specifying contact or person on the source and destination sides of the relation. A join is made to the relationTarget table to pick out the correct relation definitions to show. The RelationListProvider.RelationType enum can be used to avoid strings when specifying the relation type.
The extraInfo field in the items contains the passive (reverse) text, useful for display.Fields
ProviderName
MDO list provider for contact/person relation definitions. This provider is a takes a mandatory additionalInfo parameter, that specifies what kind of relation should be fetched.
Declaration
public const string ProviderName = "ContactRelationDefinition"Field Value
| Type | Description |
|---|---|
| string |
Remarks
AdditionalInfo can be one of 'CC', 'CP', 'PC', 'PP', specifying contact or person on the source and destination sides of the relation. A join is made to the relationTarget table to pick out the correct relation definitions to show. The RelationListProvider.RelationType enum can be used to avoid strings when specifying the relation type.
The extraInfo field in the items contains the passive (reverse) text, useful for display.Properties
HistoryInfo
History information for the list
Declaration
public override HistoryInfo HistoryInfo { get; }Property Value
| Type | Description |
|---|---|
| HistoryInfo |
Overrides
Remarks
AdditionalInfo can be one of 'CC', 'CP', 'PC', 'PP', specifying contact or person on the source and destination sides of the relation. A join is made to the relationTarget table to pick out the correct relation definitions to show. The RelationListProvider.RelationType enum can be used to avoid strings when specifying the relation type.
The extraInfo field in the items contains the passive (reverse) text, useful for display.Methods
Construct(string, string, int[], bool, string, bool)
Parse the desired relation type; pass on the physical table name to the base class, and (indirectly) construct the list
Declaration
public override void Construct(string tableName, string additionalInfo, int[] historyIDs, bool onlyReadHistory, string searchValue, bool forceFlatList)Parameters
| Type | Name | Description |
|---|---|---|
| string | tableName | |
| string | additionalInfo | |
| int[] | historyIDs | |
| bool | onlyReadHistory | |
| string | searchValue | |
| bool | forceFlatList |
Overrides
Remarks
AdditionalInfo can be one of 'CC', 'CP', 'PC', 'PP', specifying contact or person on the source and destination sides of the relation. A join is made to the relationTarget table to pick out the correct relation definitions to show. The RelationListProvider.RelationType enum can be used to avoid strings when specifying the relation type.
The extraInfo field in the items contains the passive (reverse) text, useful for display.GetItemExtraInfo(ListTableRow)
Override: Fetch the passive_text field as the extraInfo
Declaration
protected override string GetItemExtraInfo(ListTableRow row)Parameters
| Type | Name | Description |
|---|---|---|
| ListTableRow | row |
Returns
| Type | Description |
|---|---|
| string |
Overrides
Remarks
AdditionalInfo can be one of 'CC', 'CP', 'PC', 'PP', specifying contact or person on the source and destination sides of the relation. A join is made to the relationTarget table to pick out the correct relation definitions to show. The RelationListProvider.RelationType enum can be used to avoid strings when specifying the relation type.
The extraInfo field in the items contains the passive (reverse) text, useful for display.GetItemIconHint(ListTableRow)
Get a value for the field IconHint in ISoList for an item element
Declaration
protected override string GetItemIconHint(ListTableRow row)Parameters
| Type | Name | Description |
|---|---|---|
| ListTableRow | row | The actual row for which the item is created |
Returns
| Type | Description |
|---|---|
| string | An icon hint text |
Overrides
Remarks
AdditionalInfo can be one of 'CC', 'CP', 'PC', 'PP', specifying contact or person on the source and destination sides of the relation. A join is made to the relationTarget table to pick out the correct relation definitions to show. The RelationListProvider.RelationType enum can be used to avoid strings when specifying the relation type.
The extraInfo field in the items contains the passive (reverse) text, useful for display.GetItemsAndHeadingsQuery()
Override: Add our extra join, restriction and fields to a headings/items list query
Declaration
protected override ListTableRows.CustomSearch GetItemsAndHeadingsQuery()Returns
| Type | Description |
|---|---|
| ListTableRows.CustomSearch |
Overrides
Remarks
AdditionalInfo can be one of 'CC', 'CP', 'PC', 'PP', specifying contact or person on the source and destination sides of the relation. A join is made to the relationTarget table to pick out the correct relation definitions to show. The RelationListProvider.RelationType enum can be used to avoid strings when specifying the relation type.
The extraInfo field in the items contains the passive (reverse) text, useful for display.GetSimpleListQuery()
Override: Add our extra join, restriction and fields to a simple list query
Declaration
protected override ListTableRows.CustomSearch GetSimpleListQuery()Returns
| Type | Description |
|---|---|
| ListTableRows.CustomSearch |
Overrides
Remarks
AdditionalInfo can be one of 'CC', 'CP', 'PC', 'PP', specifying contact or person on the source and destination sides of the relation. A join is made to the relationTarget table to pick out the correct relation definitions to show. The RelationListProvider.RelationType enum can be used to avoid strings when specifying the relation type.
The extraInfo field in the items contains the passive (reverse) text, useful for display.