Class ReportLabelLayoutProvider

This archive provider enables access to the information regarding report label layout.

Inheritance
object
ExtensibleColumnsBase
QueryProviderBase<ArchiveRow>
ReportLabelLayoutProvider
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[ArchiveProvider("ReportLabelLayout", 1073741823)]
public class ReportLabelLayoutProvider : QueryProviderBase<ArchiveRow>, IArchiveProviderQueryMapping, IArchiveQueryProvider, IArchiveProviderExtensible, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities

Constructors

ReportLabelLayoutProvider()

This archive provider enables access to the information regarding report label layout.

Declaration
public ReportLabelLayoutProvider()

Fields

Centimeters

This archive provider enables access to the information regarding report label layout.

Declaration
public const string Centimeters = "Centimeters"
Field Value
Type Description
string

ColumnDescription

This archive provider enables access to the information regarding report label layout.

Declaration
public const string ColumnDescription = "description"
Field Value
Type Description
string

ColumnLayout

This archive provider enables access to the information regarding report label layout.

Declaration
public const string ColumnLayout = "layout"
Field Value
Type Description
string

ColumnName

This archive provider enables access to the information regarding report label layout.

Declaration
public const string ColumnName = "name"
Field Value
Type Description
string

ColumnOrientation

This archive provider enables access to the information regarding report label layout.

Declaration
public const string ColumnOrientation = "orientation"
Field Value
Type Description
string

ColumnPaperSize

This archive provider enables access to the information regarding report label layout.

Declaration
public const string ColumnPaperSize = "papersize"
Field Value
Type Description
string

ColumnPrimaryKey

This archive provider enables access to the information regarding report label layout.

Declaration
public const string ColumnPrimaryKey = "labelLayoutId"
Field Value
Type Description
string

EntityName

This archive provider enables access to the information regarding report label layout.

Declaration
public const string EntityName = "reportLabelLayout"
Field Value
Type Description
string

Inches

This archive provider enables access to the information regarding report label layout.

Declaration
public const string Inches = "Inches"
Field Value
Type Description
string

ProviderName

This archive provider enables access to the information regarding report label layout.

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

ReportLabelLayoutUnitsName

This archive provider enables access to the information regarding report label layout.

Declaration
public const string ReportLabelLayoutUnitsName = "units"
Field Value
Type Description
string

_colDescription

This archive provider enables access to the information regarding report label layout.

Declaration
protected ArchiveColumnInfo _colDescription
Field Value
Type Description
ArchiveColumnInfo

_colLayout

This archive provider enables access to the information regarding report label layout.

Declaration
protected ArchiveColumnInfo _colLayout
Field Value
Type Description
ArchiveColumnInfo

_colName

This archive provider enables access to the information regarding report label layout.

Declaration
protected ArchiveColumnInfo _colName
Field Value
Type Description
ArchiveColumnInfo

_colOrientation

This archive provider enables access to the information regarding report label layout.

Declaration
protected ArchiveColumnInfo _colOrientation
Field Value
Type Description
ArchiveColumnInfo

_colPaperSize

This archive provider enables access to the information regarding report label layout.

Declaration
protected ArchiveColumnInfo _colPaperSize
Field Value
Type Description
ArchiveColumnInfo

_colPrimaryKey

This archive provider enables access to the information regarding report label layout.

Declaration
protected ArchiveColumnInfo _colPrimaryKey
Field Value
Type Description
ArchiveColumnInfo

Properties

PrimaryTable

The primary table of this archive provider, from the derived class

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

Query

The main query of this archive provider, from the derived class

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

RootExtenders

This provider uses no extenders and thus does not support dynamic columns

Declaration
protected override List<IArchiveExtender> RootExtenders { get; }
Property Value
Type Description
List<IArchiveExtender>
Overrides

Methods

InnerMapFieldsAsync(CancellationToken)

Override this method to map query fields to columns, add additional return fields to the query, and set up custom restriction handling

Declaration
public override Task InnerMapFieldsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides

InnerPopulateRowFromReader(SoDataReader, ArchiveRow)

Derived classes should implement the population of ColumnData items for columns that are NOT handled by this base class in this method. Whether a column is handled by this base class is part of its database binding information, set by the various MapXXX methods.

Declaration
protected override void InnerPopulateRowFromReader(SoDataReader reader, ArchiveRow row)
Parameters
Type Name Description
SoDataReader reader

Data reader with the query result (one row)
ArchiveRow row

archive row to be populated
Overrides

SetRestriction(params ArchiveRestrictionInfo[])

Set the restriction by calling the base class and InnerSetRestriction; take this opportunity to note that a restriction has actually been set, so we can report cases of totally missing restrictions (which is not acceptable as it might end up fetching the whole database)

Declaration
public override bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Type Name Description
ArchiveRestrictionInfo[] restrictions
Returns
Type Description
bool
Overrides

Implements

Extension Methods