Show / Hide Table of Contents

Class MergeDocumentListProvider

MDO list provider for documents marked as type MailMergeDraft.

Inheritance
Object
AnyTableListProviderBase
DocumentListProvider
MergeDocumentListProvider
Implements
ISoListProvider
ISoList
Inherited Members
DocumentListProvider._documentTableInfo
DocumentListProvider.Init()
DocumentListProvider.SetSearchRestriction(Select, String)
DocumentListProvider.TableInfo
AnyTableListProviderBase.Construct(String, String, Int32[], Boolean, String, Boolean)
AnyTableListProviderBase.GetHistoryItems()
AnyTableListProviderBase.GetRootItems()
AnyTableListProviderBase.OnPreGetRootItems(List<ISoListItem>)
AnyTableListProviderBase.OnPostGetRootItems(List<ISoListItem>)
AnyTableListProviderBase.ExecuteQuery(Select, List<ISoListItem>)
AnyTableListProviderBase.ExecuteReader(SoCommand)
AnyTableListProviderBase.ListName
AnyTableListProviderBase.AdditionalInfo
AnyTableListProviderBase.HistoryIDs
AnyTableListProviderBase.OnlyReadHistory
AnyTableListProviderBase.ExcludeHistory
AnyTableListProviderBase.SearchValue
AnyTableListProviderBase.ForceFlatList
AnyTableListProviderBase.HistoryItems
AnyTableListProviderBase.RootItems
AnyTableListProviderBase.HeadingItems
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("mergedocument")]
public class MergeDocumentListProvider : DocumentListProvider, ISoListProvider, ISoList, IPlugin

Constructors

MergeDocumentListProvider()

Constructor

Declaration
public MergeDocumentListProvider()

Fields

ProviderName

MDO list provider for documents marked as type MailMergeDraft.

Declaration
public const string ProviderName = "mergedocument"
Field Value
Type Description
String

Properties

HistoryInfo

History information for a history of type MailMerge.

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

Methods

GetMainQuery()

Get the main query for returning mailmerge documents.

Declaration
protected override Select GetMainQuery()
Returns
Type Description
Select
Overrides
DocumentListProvider.GetMainQuery()

OnRead(SoDataReader, Int16)

Raised every time a new row has been read from the database.
If the ISoListItem.Name is empty, it is replaced with a resource string for (blank).

Declaration
protected override ISoListItem OnRead(SoDataReader reader, short lastRank)
Parameters
Type Name Description
SoDataReader reader

Reader to reaf from.

Int16 lastRank

Value of the last rank populated.

Returns
Type Description
ISoListItem

Data read from the reader.

Overrides
DocumentListProvider.OnRead(SoDataReader, Int16)

SetHistoryRestriction(Select)

Set History restriction to the query. Only histories with extraId = MailMergeDraft are returned.

Declaration
protected override void SetHistoryRestriction(Select sql)
Parameters
Type Name Description
Select sql

The query to modify.

Overrides
AnyTableListProviderBase.SetHistoryRestriction(Select)

Implements

ISoListProvider
ISoList

Extension Methods

EnumUtil.MapEnums<From, To>(From)
ObjectExtensions.AssignByReflection<T>(T, T)
ObjectExtensions.GraphCopy<T>(T)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top