Class BaseReport

Base class for Report, defines basic functionallity

Inheritance
object
ReportItem
BaseReport
Report
Implements
Inherited Members
Namespace: Reportman.Reporting
Assembly: Reportman.Reporting.dll
Syntax
public abstract class BaseReport : ReportItem, IDisposable

Constructors

BaseReport()

Declaration
protected BaseReport()

Fields

AbortingThread

Tells the engine if the background thread must be abort

Declaration
protected bool AbortingThread
Field Value
Type Description
bool

AsyncExecution

Set this property to true if you want to enable asynchronous execution, that is the first page will be calculated and the other pages will be calculated in a background thread

Declaration
public bool AsyncExecution
Field Value
Type Description
bool

AsyncPriority

Priority for the background execution thread, usually lower than the main thread

Declaration
public ThreadPriority AsyncPriority
Field Value
Type Description
ThreadPriority

ChartingDriver

Driver por charting

Declaration
public PrintOut ChartingDriver
Field Value
Type Description
PrintOut

Components

List of all components related to the report

Declaration
[JsonIgnore]
[JsonIgnore]
public ReportItems Components
Field Value
Type Description
ReportItems

CurrentOrientation

Declaration
public OrientationType CurrentOrientation
Field Value
Type Description
OrientationType

CurrentSectionIndex

Current section index being processed

Declaration
protected int CurrentSectionIndex
Field Value
Type Description
int

CurrentSubReportIndex

Current subreport index being processed

Declaration
public int CurrentSubReportIndex
Field Value
Type Description
int

EmbeddedFiles

Declaration
public List<EmbeddedFile> EmbeddedFiles
Field Value
Type Description
List<EmbeddedFile>

ErrorProcessing

Used to check a runtime error in report processing

Declaration
protected bool ErrorProcessing
Field Value
Type Description
bool

EvalIdens

A list of expression evaluator identifiers, added to handle special report items like current page, current language...

Declaration
protected EvalIdentifiers EvalIdens
Field Value
Type Description
EvalIdentifiers

Evaluator

Declaration
[JsonIgnore]
[JsonIgnore]
public Evaluator Evaluator
Field Value
Type Description
Evaluator

ExecuteSubReportIndexes

List of subreports to execute, if not assigned or empty all subreports will be executed

Declaration
[JsonIgnore]
[JsonIgnore]
public List<int> ExecuteSubReportIndexes
Field Value
Type Description
List<int>

FCompose

Determine if the report is composed of multiple reports

Declaration
protected bool FCompose
Field Value
Type Description
bool

FDataAlias

A Dataset set can be passed to the engine to replace the datasets definitions in the report scheme

Declaration
protected DatasetAlias FDataAlias
Field Value
Type Description
DatasetAlias

FDriver

Current print driver

Declaration
protected PrintOut FDriver
Field Value
Type Description
PrintOut

FExecuting

True if the report is still executing in the bacground thread

Declaration
protected bool FExecuting
Field Value
Type Description
bool

FGroupHeaders

List of group headers

Declaration
protected Sections FGroupHeaders
Field Value
Type Description
Sections

FRecordCount

Number of records processed by the main dataset in the current subreport

Declaration
protected int FRecordCount
Field Value
Type Description
int

FreeSpace

Current free space in the current page (at the bottom)

Declaration
public int FreeSpace
Field Value
Type Description
int

GFooters

List of page footers to be printed in the bottom of the page

Declaration
protected Sections GFooters
Field Value
Type Description
Sections

GHeaders

List of page headers, to be repeated on each page (groups and page headers)

Declaration
protected Sections GHeaders
Field Value
Type Description
Sections

InitialPageDetail

Declaration
public PageSizeDetail InitialPageDetail
Field Value
Type Description
PageSizeDetail

InternalPageHeight

Effective page height for current page

Declaration
public int InternalPageHeight
Field Value
Type Description
int

InternalPageWidth

Effective page width for current page

Declaration
public int InternalPageWidth
Field Value
Type Description
int

LastErrorProcessing

Error message when a error in report processing occur

Declaration
protected string LastErrorProcessing
Field Value
Type Description
string

LastPage

This variable is true if the report have ended and the current page is the last page

Declaration
protected bool LastPage
Field Value
Type Description
bool

MAX_PAGENUM

Maximum number of pages a report can handle

Declaration
public const int MAX_PAGENUM = 100000
Field Value
Type Description
int

Modified

Report has been modified (designer)

Declaration
[JsonIgnore]
[JsonIgnore]
public bool Modified
Field Value
Type Description
bool

PDFCompressed

Declaration
public bool PDFCompressed
Field Value
Type Description
bool

PDFConformance

Declaration
public PDFConformanceType PDFConformance
Field Value
Type Description
PDFConformanceType

PageNum

Current page number (zero based index)

Declaration
public int PageNum
Field Value
Type Description
int

PageNumGroup

Current page number for current group (zero based index)

Declaration
public int PageNumGroup
Field Value
Type Description
int

PendingSections

Sections still not drawn, but mandatory to draw before continuing report processing

Declaration
protected Sections PendingSections
Field Value
Type Description
Sections

PrintedSomething

True if the engine have printed some item

Declaration
public bool PrintedSomething
Field Value
Type Description
bool

UndoCue

Undo cue

Declaration
public UndoCue UndoCue
Field Value
Type Description
UndoCue

UpdatePageSize

Declaration
public bool UpdatePageSize
Field Value
Type Description
bool

UsedDataReaders

Declaration
public SortedList<string, string> UsedDataReaders
Field Value
Type Description
SortedList<string, string>

asection

Temporary section

Declaration
protected Section asection
Field Value
Type Description
Section

havepagefooters

True if there are page footers to print

Declaration
protected bool havepagefooters
Field Value
Type Description
bool

mmfirst

Variable storing the first time the report progress was updated

Declaration
protected DateTime mmfirst
Field Value
Type Description
DateTime

mmlast

Variable storing the last time the report progress was updated

Declaration
protected DateTime mmlast
Field Value
Type Description
DateTime

oldprintedsection

Latest printed section

Declaration
protected Section oldprintedsection
Field Value
Type Description
Section

oldprintedsectionext

Latest section index already measured

Declaration
protected Point oldprintedsectionext
Field Value
Type Description
Point

oldsubreport

Latest subreport

Declaration
protected SubReport oldsubreport
Field Value
Type Description
SubReport

pagefooterpos

Position to print page footers

Declaration
protected int pagefooterpos
Field Value
Type Description
int

pagefooters

Page footers to print at the end of the page

Declaration
protected Sections pagefooters
Field Value
Type Description
Sections

pageposx

Current horizontal position in the current page

Declaration
protected int pageposx
Field Value
Type Description
int

pageposy

Current vertical position in the current page

Declaration
protected int pageposy
Field Value
Type Description
int

pagespacex

Maximum horizontal space in the current page

Declaration
protected int pagespacex
Field Value
Type Description
int

printing

True if the report is printing

Declaration
protected bool printing
Field Value
Type Description
bool

section

Current section being processed

Declaration
protected Section section
Field Value
Type Description
Section

sectionext

Currrent section size

Declaration
protected Point sectionext
Field Value
Type Description
Point

sectionextevaluated

True if the section extension have already evaluated

Declaration
protected bool sectionextevaluated
Field Value
Type Description
bool

subreport

Current subreport being processed

Declaration
protected SubReport subreport
Field Value
Type Description
SubReport

Properties

ActionAfter

Declaration
public bool ActionAfter { get; set; }
Property Value
Type Description
bool

ActionBefore

Declaration
public bool ActionBefore { get; set; }
Property Value
Type Description
bool

Alignment

Declaration
public TextAlignType Alignment { get; set; }
Property Value
Type Description
TextAlignType

AutoScale

Default scale when the preview is executed

Declaration
public AutoScaleType AutoScale { get; set; }
Property Value
Type Description
AutoScaleType

BackColor

Declaration
public int BackColor { get; set; }
Property Value
Type Description
int

BottomMargin

Bottom margin in twips

Declaration
public int BottomMargin { get; set; }
Property Value
Type Description
int

CollateCopies

Collate copies by default

Declaration
public bool CollateCopies { get; set; }
Property Value
Type Description
bool

Compose

Declaration
[JsonIgnore]
[JsonIgnore]
public bool Compose { get; set; }
Property Value
Type Description
bool

Copies

Number of copies to print by default

Declaration
public int Copies { get; set; }
Property Value
Type Description
int

CustomPageHeight

Page height in twips, if the page size is custom defined

Declaration
public int CustomPageHeight { get; set; }
Property Value
Type Description
int

CustomPageWidth

Page width in twips, if the page size is custom defined

Declaration
public int CustomPageWidth { get; set; }
Property Value
Type Description
int

CutText

Declaration
public bool CutText { get; set; }
Property Value
Type Description
bool

DataInfo

Report datasets collection

Declaration
public DataInfos DataInfo { get; set; }
Property Value
Type Description
DataInfos

DatabaseInfo

Report databases collections (available connections)

Declaration
public DatabaseInfos DatabaseInfo { get; set; }
Property Value
Type Description
DatabaseInfos

DocAuthor

Declaration
public string DocAuthor { get; set; }
Property Value
Type Description
string

DocCreationDate

Declaration
public string DocCreationDate { get; set; }
Property Value
Type Description
string

DocCreator

Declaration
public string DocCreator { get; set; }
Property Value
Type Description
string

DocKeywords

Declaration
public string DocKeywords { get; set; }
Property Value
Type Description
string

DocModificationDate

Declaration
public string DocModificationDate { get; set; }
Property Value
Type Description
string

DocProducer

Declaration
public string DocProducer { get; set; }
Property Value
Type Description
string

DocSubject

Declaration
public string DocSubject { get; set; }
Property Value
Type Description
string

DocTitle

Declaration
public string DocTitle { get; set; }
Property Value
Type Description
string

DocXMPContent

Declaration
public string DocXMPContent { get; set; }
Property Value
Type Description
string

Driver

The print driver used by the engine to calculate or print the report

Declaration
[JsonIgnore]
[JsonIgnore]
public PrintOut Driver { get; }
Property Value
Type Description
PrintOut

Duplex

Declaration
public int Duplex { get; set; }
Property Value
Type Description
int

FontColor

Declaration
public int FontColor { get; set; }
Property Value
Type Description
int

FontRotation

Declaration
public short FontRotation { get; set; }
Property Value
Type Description
short

FontSize

Declaration
public short FontSize { get; set; }
Property Value
Type Description
short

FontStyle

Declaration
public int FontStyle { get; set; }
Property Value
Type Description
int

ForcePaperName

Declaration
public string ForcePaperName { get; set; }
Property Value
Type Description
string

GridColor

Define the grid color while designing the report

Declaration
public int GridColor { get; set; }
Property Value
Type Description
int

GridEnabled

Define if the grid is enabled while designing the report, that is, by default report components will be placed at the nearest grid position

Declaration
public bool GridEnabled { get; set; }
Property Value
Type Description
bool

GridHeight

Grid height interval in twips

Declaration
public int GridHeight { get; set; }
Property Value
Type Description
int

GridLines

Define if the grid should be painted as horizontal and vertical lines instead of points

Declaration
public bool GridLines { get; set; }
Property Value
Type Description
bool

GridVisible

Define if the grid should be visible while designing the report

Declaration
public bool GridVisible { get; set; }
Property Value
Type Description
bool

GridWidth

Grid width interval in twips

Declaration
public int GridWidth { get; set; }
Property Value
Type Description
int

LFontName

Linux font name, that is the default font name while designing the report scheme

Declaration
public string LFontName { get; set; }
Property Value
Type Description
string

Language

Current language index

Declaration
public int Language { get; set; }
Property Value
Type Description
int

LeftMargin

Left margin in twips

Declaration
public int LeftMargin { get; set; }
Property Value
Type Description
int

LinesPerInch

Declaration
public short LinesPerInch { get; set; }
Property Value
Type Description
short

MetaFile

Report Metafile storing drawing information for the report, that is pages and objects inside pages

Declaration
[JsonIgnore]
[JsonIgnore]
public MetaFile MetaFile { get; set; }
Property Value
Type Description
MetaFile

MultiPage

Declaration
public bool MultiPage { get; set; }
Property Value
Type Description
bool

PageBackColor

Background color for the pages in preview

Declaration
public int PageBackColor { get; set; }
Property Value
Type Description
int

PageHeight

Page height in twips

Declaration
public int PageHeight { get; set; }
Property Value
Type Description
int

PageOrientation

Page orientation for the report

Declaration
public OrientationType PageOrientation { get; set; }
Property Value
Type Description
OrientationType

PageSize

Page size for the report

Declaration
public PageSizeType PageSize { get; set; }
Property Value
Type Description
PageSizeType

PageSizeIndex

Page size index if applicable, when it matchs the Windows GDI page size indexes

Declaration
public int PageSizeIndex { get; set; }
Property Value
Type Description
int

PageWidth

Page width in twips

Declaration
public int PageWidth { get; set; }
Property Value
Type Description
int

PaperSource

Declaration
public int PaperSource { get; set; }
Property Value
Type Description
int

Params

Report parameters collection

Declaration
public Params Params { get; set; }
Property Value
Type Description
Params

PreviewAbout

Declaration
public bool PreviewAbout { get; set; }
Property Value
Type Description
bool

PreviewMargins

Declaration
public bool PreviewMargins { get; set; }
Property Value
Type Description
bool

PreviewWindow

Default window size when the preview is executed

Declaration
public PreviewWindowStyleType PreviewWindow { get; set; }
Property Value
Type Description
PreviewWindowStyleType

PrintOnlyIfDataAvailable

Declaration
public bool PrintOnlyIfDataAvailable { get; set; }
Property Value
Type Description
bool

PrintStep

Declaration
public PrintStepType PrintStep { get; set; }
Property Value
Type Description
PrintStepType

PrinterFonts

Declaration
public PrinterFontsType PrinterFonts { get; set; }
Property Value
Type Description
PrinterFontsType

PrinterSelect

Printer selection option

Declaration
public PrinterSelectType PrinterSelect { get; set; }
Property Value
Type Description
PrinterSelectType

RecordCount

Number of records processed by the main dataset in the current subreport

Declaration
[JsonIgnore]
[JsonIgnore]
public int RecordCount { get; }
Property Value
Type Description
int

RightMargin

Right margin in twips

Declaration
public int RightMargin { get; set; }
Property Value
Type Description
int

SingleLine

Declaration
public bool SingleLine { get; set; }
Property Value
Type Description
bool

StreamFormat

Declaration
public StreamFormatType StreamFormat { get; set; }
Property Value
Type Description
StreamFormatType

SubReports

Collection of subreports

Declaration
public SubReports SubReports { get; set; }
Property Value
Type Description
SubReports

TopMargin

Top margin in twips

Declaration
public int TopMargin { get; set; }
Property Value
Type Description
int

Transparent

Declaration
public bool Transparent { get; set; }
Property Value
Type Description
bool

TwoPass

Two pass report option, when two pass is enabled the first page of the report is not shown (or print) until the full report is calculated, this option allow the use of PAGECOUNT special expression and other advanced features like skip to page and position properties in sections.

Declaration
public bool TwoPass { get; set; }
Property Value
Type Description
bool

Type1Font

Declaration
public PDFFontType Type1Font { get; set; }
Property Value
Type Description
PDFFontType

VAlignment

Declaration
public TextAlignVerticalType VAlignment { get; set; }
Property Value
Type Description
TextAlignVerticalType

WFontName

Windows font name, that is the default font name while designing the report scheme

Declaration
public string WFontName { get; set; }
Property Value
Type Description
string

WordWrap

Declaration
public bool WordWrap { get; set; }
Property Value
Type Description
bool

Methods

ActivateDatasets()

Declaration
protected void ActivateDatasets()

AddComponent(ReportItem)

Declaration
public void AddComponent(ReportItem it)
Parameters
Type Name Description
ReportItem it

AddReportItemsToEvaluator(Evaluator)

Declaration
public void AddReportItemsToEvaluator(Evaluator eval)
Parameters
Type Name Description
Evaluator eval

AddSubReport()

Declaration
public SubReport AddSubReport()
Returns
Type Description
SubReport

AddTotalPagesItem(int, int, string)

Declaration
public void AddTotalPagesItem(int apageindex, int aobjectindex, string adisplayformat)
Parameters
Type Name Description
int apageindex
int aobjectindex
string adisplayformat

AlignSectionsTo(int)

Declaration
public void AlignSectionsTo(int linesPerInch)
Parameters
Type Name Description
int linesPerInch

BeginPrint(PrintOut)

Declaration
public virtual void BeginPrint(PrintOut driver)
Parameters
Type Name Description
PrintOut driver

CheckIfDataAvailable()

Declaration
protected void CheckIfDataAvailable()

CheckParameters()

Declaration
public string CheckParameters()
Returns
Type Description
string

CheckProgress(bool)

Internal progress procedure

Declaration
protected void CheckProgress(bool finished)
Parameters
Type Name Description
bool finished

When finished calls an event if assigned

ConvertToDotNet()

Converts a report to dot net, changing data driver type and parameters in sql sentences

Declaration
public void ConvertToDotNet()

CreateNew()

Declaration
public void CreateNew()

DeActivateDatasets()

Declaration
protected void DeActivateDatasets()

DeleteComponent(ReportItem)

Declaration
public void DeleteComponent(ReportItem item)
Parameters
Type Name Description
ReportItem item

DeleteComponentPrintPosItem(Section, PrintPosItem, int, int)

Declaration
public void DeleteComponentPrintPosItem(Section section, PrintPosItem compo, int index, int groupId)
Parameters
Type Name Description
Section section
PrintPosItem compo
int index
int groupId

DeleteComponents(Section, int)

Declaration
public void DeleteComponents(Section section, int groupId)
Parameters
Type Name Description
Section section
int groupId

DeleteItem(ReportItem, int)

Declaration
public void DeleteItem(ReportItem item, int groupId)
Parameters
Type Name Description
ReportItem item
int groupId

DeleteSubReport(SubReport)

Declaration
public void DeleteSubReport(SubReport sub)
Parameters
Type Name Description
SubReport sub

Dispose()

Declaration
public void Dispose()

DoUpdatePageSize(MetaPage, PageSizeDetail)

Declaration
public void DoUpdatePageSize(MetaPage MetaFilepage, PageSizeDetail detail)
Parameters
Type Name Description
MetaPage MetaFilepage
PageSizeDetail detail

EndPrint()

Declaration
public void EndPrint()

FillGlobalHeaders()

Declaration
protected void FillGlobalHeaders()

FindNewName(ReportItem)

Find new name for a report item

Declaration
public string FindNewName(ReportItem ritem)
Parameters
Type Name Description
ReportItem ritem
Returns
Type Description
string

GenerateNewName(ReportItem)

Create a new name for a report item

Declaration
public void GenerateNewName(ReportItem ritem)
Parameters
Type Name Description
ReportItem ritem

GetParentSection(PrintPosItem)

Declaration
public Section GetParentSection(PrintPosItem item)
Parameters
Type Name Description
PrintPosItem item
Returns
Type Description
Section

GetParentSubReport(Section)

Declaration
public SubReport GetParentSubReport(Section section)
Parameters
Type Name Description
Section section
Returns
Type Description
SubReport

GetReportVariables()

Obtain a list of available identifiers that can be used in a expression inside Evaluator class

Declaration
public Strings GetReportVariables()
Returns
Type Description
Strings

InitEvaluator()

Declaration
public void InitEvaluator()

InitializeParams()

Declaration
public void InitializeParams()

LoadFromCommand(IDbCommand)

Declaration
public void LoadFromCommand(IDbCommand selecommand)
Parameters
Type Name Description
IDbCommand selecommand

LoadFromDataReader(IDataReader)

Declaration
public void LoadFromDataReader(IDataReader areader)
Parameters
Type Name Description
IDataReader areader

LoadFromFile(string)

Declaration
public void LoadFromFile(string filename)
Parameters
Type Name Description
string filename

LoadFromStream(Stream)

Declaration
public void LoadFromStream(Stream astream)
Parameters
Type Name Description
Stream astream

LoadFromStream(Stream, int)

Declaration
public void LoadFromStream(Stream astream, int bufsize)
Parameters
Type Name Description
Stream astream
int bufsize

NewComponentByClassName(string)

Declaration
public static ReportItem NewComponentByClassName(string className)
Parameters
Type Name Description
string className
Returns
Type Description
ReportItem

PrepareParamsAfterOpen()

Declaration
protected void PrepareParamsAfterOpen()

PrepareParamsBeforeOpen()

Declaration
protected void PrepareParamsBeforeOpen()

PrintAll(PrintOut)

Declaration
public void PrintAll(PrintOut Driver)
Parameters
Type Name Description
PrintOut Driver

PrintNextPage()

Declaration
public abstract bool PrintNextPage()
Returns
Type Description
bool

RemoveComponent(ReportItem)

Declaration
public void RemoveComponent(ReportItem it)
Parameters
Type Name Description
ReportItem it

RequestPage(int)

Declaration
public bool RequestPage(int pageindex)
Parameters
Type Name Description
int pageindex
Returns
Type Description
bool

SaveToFile(string, StreamVersion)

Declaration
public void SaveToFile(string filename, StreamVersion version = StreamVersion.V2)
Parameters
Type Name Description
string filename
StreamVersion version

SaveToStream(Stream, StreamVersion)

Declaration
public void SaveToStream(Stream astream, StreamVersion version = StreamVersion.V2)
Parameters
Type Name Description
Stream astream
StreamVersion version

SubreportMustBeExecuted(SubReport)

Declaration
public bool SubreportMustBeExecuted(SubReport nsubreport)
Parameters
Type Name Description
SubReport nsubreport
Returns
Type Description
bool

UpdateParamsAfterOpen(int, bool)

Declaration
protected void UpdateParamsAfterOpen(int index, bool doeval)
Parameters
Type Name Description
int index
bool doeval

UpdateParamsBeforeOpen(int, bool)

Declaration
public void UpdateParamsBeforeOpen(int index, bool doeval)
Parameters
Type Name Description
int index
bool doeval

UpdateReferences()

Declaration
public void UpdateReferences()

Events

OnProgress

Event to track the report progress and cancel the progress if needed

Declaration
public event ReportProgress OnProgress
Event Type
Type Description
ReportProgress

OnWorkAsyncError

Event to track report errors

Declaration
public event MetaFileWorkAsyncError OnWorkAsyncError
Event Type
Type Description
MetaFileWorkAsyncError

OnWorkProgress

Event to track report progress

Declaration
public event MetaFileWorkProgress OnWorkProgress
Event Type
Type Description
MetaFileWorkProgress

Implements