Class PrivacyTemplateProvider

This is a variant of the DocTmpl list - document templates - restricted to those that are of some privacy document type.

Inheritance
object
MDOProviderBase
PrivacyTemplateProvider
Inherited Members
Namespace: SuperOfficeCRMLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("PrivacyTemplate")]
[MDOAdditionalInfo("DocTmplPrivacyType", "DocTmplPrivacyType enum value", "MainDocument")]
public class PrivacyTemplateProvider : MDOProviderBase, ISoListProvider, ISoList, IEnumerable<ISoListItem>, IEnumerable

Constructors

PrivacyTemplateProvider()

Declaration
public PrivacyTemplateProvider()

Fields

ProviderName

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

Properties

HistoryInfo

Override: Separate histories for each quote type, this may or may not be quite what people like

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

Methods

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

Initializes all class members.

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

Name of the table holding the MDO list values, like Category, Business, etc. Note that this really has to be a valid table name.
string additionalInfo
int historyIDs

List of history id's (primary keys of the table holding the MDO list values).
bool onlyReadHistory

Only read history nodes.
string searchValue

Search value (case insensetive string used like '%[searchValue]%'. The result when using this is allways a flat list without hisotry elements.
bool forceFlatList

State that a forced flat list should be returned.
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides

GetHeadingIconHint(ListTableRow)

Get a value for the field IconHint in ISoList for a heading element

Declaration
protected override string GetHeadingIconHint(ListTableRow row)
Parameters
Type Name Description
ListTableRow row

The actual row for which the item is created
Returns
Type Description
string

"Document""
Overrides

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

"Document"
Overrides

GetItemsAndHeadingsQueryAsync(CancellationToken)

Create a query for for reading the items and headings of a list.

Declaration
protected override Task<ListTableRows.CustomSearch> GetItemsAndHeadingsQueryAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
TaskListTableRowsCustomSearch

Query for reading the items and headdings of a list.
Overrides
Remarks

A search string that is not empty will result in a flattened list.

GetSimpleListQueryAsync(CancellationToken)

Declaration
protected override Task<ListTableRows.CustomSearch> GetSimpleListQueryAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
TaskListTableRowsCustomSearch
Overrides

Implements

Extension Methods