Class BaseReport
Base class for Report, defines basic functionallity
Assembly: Reportman.Reporting.dll
Syntax
public abstract class BaseReport : ReportItem, IDisposable
Constructors
View Source
BaseReport()
Declaration
Fields
View Source
AbortingThread
Tells the engine if the background thread must be abort
Declaration
protected bool AbortingThread
Field Value
View Source
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
View Source
AsyncPriority
Priority for the background execution thread, usually lower than the main thread
Declaration
public ThreadPriority AsyncPriority
Field Value
View Source
ChartingDriver
Declaration
public PrintOut ChartingDriver
Field Value
View Source
Components
List of all components related to the report
Declaration
[JsonIgnore]
[JsonIgnore]
public ReportItems Components
Field Value
View Source
CurrentOrientation
Declaration
public OrientationType CurrentOrientation
Field Value
View Source
CurrentSectionIndex
Current section index being processed
Declaration
protected int CurrentSectionIndex
Field Value
View Source
CurrentSubReportIndex
Current subreport index being processed
Declaration
public int CurrentSubReportIndex
Field Value
View Source
EmbeddedFiles
Declaration
public List<EmbeddedFile> EmbeddedFiles
Field Value
View Source
ErrorProcessing
Used to check a runtime error in report processing
Declaration
protected bool ErrorProcessing
Field Value
View Source
EvalIdens
A list of expression evaluator identifiers, added to handle special report
items like current page, current language...
Declaration
protected EvalIdentifiers EvalIdens
Field Value
View Source
Evaluator
Declaration
[JsonIgnore]
[JsonIgnore]
public Evaluator Evaluator
Field Value
View Source
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
View Source
FCompose
Determine if the report is composed of multiple reports
Declaration
Field Value
View Source
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
View Source
FDriver
Declaration
protected PrintOut FDriver
Field Value
View Source
FExecuting
True if the report is still executing in the bacground thread
Declaration
protected bool FExecuting
Field Value
View Source
Declaration
protected Sections FGroupHeaders
Field Value
View Source
FRecordCount
Number of records processed by the main dataset in the current subreport
Declaration
protected int FRecordCount
Field Value
View Source
FreeSpace
Current free space in the current page (at the bottom)
Declaration
Field Value
View Source
List of page footers to be printed in the bottom of the page
Declaration
protected Sections GFooters
Field Value
View Source
List of page headers, to be repeated on each page (groups and page headers)
Declaration
protected Sections GHeaders
Field Value
View Source
InitialPageDetail
Declaration
public PageSizeDetail InitialPageDetail
Field Value
View Source
InternalPageHeight
Effective page height for current page
Declaration
public int InternalPageHeight
Field Value
View Source
InternalPageWidth
Effective page width for current page
Declaration
public int InternalPageWidth
Field Value
View Source
LastErrorProcessing
Error message when a error in report processing occur
Declaration
protected string LastErrorProcessing
Field Value
View Source
LastPage
This variable is true if the report have ended and the current page is the last
page
Declaration
Field Value
View Source
MAX_PAGENUM
Maximum number of pages a report can handle
Declaration
public const int MAX_PAGENUM = 100000
Field Value
View Source
Modified
Report has been modified (designer)
Declaration
[JsonIgnore]
[JsonIgnore]
public bool Modified
Field Value
View Source
PDFCompressed
Declaration
public bool PDFCompressed
Field Value
View Source
Declaration
public PDFConformanceType PDFConformance
Field Value
View Source
PageNum
Current page number (zero based index)
Declaration
Field Value
View Source
PageNumGroup
Current page number for current group (zero based index)
Declaration
Field Value
View Source
PendingSections
Sections still not drawn, but mandatory to draw before continuing report
processing
Declaration
protected Sections PendingSections
Field Value
View Source
PrintedSomething
True if the engine have printed some item
Declaration
public bool PrintedSomething
Field Value
View Source
UndoCue
Declaration
Field Value
View Source
UpdatePageSize
Declaration
public bool UpdatePageSize
Field Value
View Source
UsedDataReaders
Declaration
public SortedList<string, string> UsedDataReaders
Field Value
View Source
asection
Declaration
protected Section asection
Field Value
View Source
True if there are page footers to print
Declaration
protected bool havepagefooters
Field Value
View Source
mmfirst
Variable storing the first time the report progress was updated
Declaration
protected DateTime mmfirst
Field Value
View Source
mmlast
Variable storing the last time the report progress was updated
Declaration
protected DateTime mmlast
Field Value
View Source
oldprintedsection
Declaration
protected Section oldprintedsection
Field Value
View Source
oldprintedsectionext
Latest section index already measured
Declaration
protected Point oldprintedsectionext
Field Value
View Source
oldsubreport
Declaration
protected SubReport oldsubreport
Field Value
View Source
Position to print page footers
Declaration
protected int pagefooterpos
Field Value
View Source
Page footers to print at the end of the page
Declaration
protected Sections pagefooters
Field Value
View Source
pageposx
Current horizontal position in the current page
Declaration
Field Value
View Source
pageposy
Current vertical position in the current page
Declaration
Field Value
View Source
pagespacex
Maximum horizontal space in the current page
Declaration
Field Value
View Source
printing
True if the report is printing
Declaration
Field Value
View Source
section
Current section being processed
Declaration
protected Section section
Field Value
View Source
sectionext
Declaration
protected Point sectionext
Field Value
View Source
sectionextevaluated
True if the section extension have already evaluated
Declaration
protected bool sectionextevaluated
Field Value
View Source
subreport
Current subreport being processed
Declaration
protected SubReport subreport
Field Value
Properties
View Source
ActionAfter
Declaration
public bool ActionAfter { get; set; }
Property Value
View Source
ActionBefore
Declaration
public bool ActionBefore { get; set; }
Property Value
View Source
Alignment
Declaration
public TextAlignType Alignment { get; set; }
Property Value
View Source
AutoScale
Default scale when the preview is executed
Declaration
public AutoScaleType AutoScale { get; set; }
Property Value
View Source
BackColor
Declaration
public int BackColor { get; set; }
Property Value
View Source
BottomMargin
Declaration
public int BottomMargin { get; set; }
Property Value
View Source
CollateCopies
Collate copies by default
Declaration
public bool CollateCopies { get; set; }
Property Value
View Source
Compose
Declaration
[JsonIgnore]
[JsonIgnore]
public bool Compose { get; set; }
Property Value
View Source
Copies
Number of copies to print by default
Declaration
public int Copies { get; set; }
Property Value
View Source
CustomPageHeight
Page height in twips, if the page size is custom defined
Declaration
public int CustomPageHeight { get; set; }
Property Value
View Source
CustomPageWidth
Page width in twips, if the page size is custom defined
Declaration
public int CustomPageWidth { get; set; }
Property Value
View Source
CutText
Declaration
public bool CutText { get; set; }
Property Value
View Source
DataInfo
Report datasets collection
Declaration
public DataInfos DataInfo { get; set; }
Property Value
View Source
DatabaseInfo
Report databases collections (available connections)
Declaration
public DatabaseInfos DatabaseInfo { get; set; }
Property Value
View Source
DocAuthor
Declaration
public string DocAuthor { get; set; }
Property Value
View Source
DocCreationDate
Declaration
public string DocCreationDate { get; set; }
Property Value
View Source
DocCreator
Declaration
public string DocCreator { get; set; }
Property Value
View Source
DocKeywords
Declaration
public string DocKeywords { get; set; }
Property Value
View Source
DocModificationDate
Declaration
public string DocModificationDate { get; set; }
Property Value
View Source
DocProducer
Declaration
public string DocProducer { get; set; }
Property Value
View Source
DocSubject
Declaration
public string DocSubject { get; set; }
Property Value
View Source
DocTitle
Declaration
public string DocTitle { get; set; }
Property Value
View Source
DocXMPContent
Declaration
public string DocXMPContent { get; set; }
Property Value
View Source
Driver
The print driver used by the engine to calculate or print the report
Declaration
[JsonIgnore]
[JsonIgnore]
public PrintOut Driver { get; }
Property Value
View Source
Duplex
Declaration
public int Duplex { get; set; }
Property Value
View Source
FontColor
Declaration
public int FontColor { get; set; }
Property Value
View Source
FontRotation
Declaration
public short FontRotation { get; set; }
Property Value
View Source
FontSize
Declaration
public short FontSize { get; set; }
Property Value
View Source
FontStyle
Declaration
public int FontStyle { get; set; }
Property Value
View Source
ForcePaperName
Declaration
public string ForcePaperName { get; set; }
Property Value
View Source
GridColor
Define the grid color while designing the report
Declaration
public int GridColor { get; set; }
Property Value
View Source
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
View Source
GridHeight
Grid height interval in twips
Declaration
public int GridHeight { get; set; }
Property Value
View Source
GridLines
Define if the grid should be painted as horizontal and vertical lines instead of
points
Declaration
public bool GridLines { get; set; }
Property Value
View Source
GridVisible
Define if the grid should be visible while designing the report
Declaration
public bool GridVisible { get; set; }
Property Value
View Source
GridWidth
Grid width interval in twips
Declaration
public int GridWidth { get; set; }
Property Value
View Source
LFontName
Linux font name, that is the default font name while designing the report scheme
Declaration
public string LFontName { get; set; }
Property Value
View Source
Language
Declaration
public int Language { get; set; }
Property Value
View Source
LeftMargin
Declaration
public int LeftMargin { get; set; }
Property Value
View Source
LinesPerInch
Declaration
public short LinesPerInch { get; set; }
Property Value
View Source
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
View Source
MultiPage
Declaration
public bool MultiPage { get; set; }
Property Value
View Source
PageBackColor
Background color for the pages in preview
Declaration
public int PageBackColor { get; set; }
Property Value
View Source
PageHeight
Declaration
public int PageHeight { get; set; }
Property Value
View Source
PageOrientation
Page orientation for the report
Declaration
public OrientationType PageOrientation { get; set; }
Property Value
View Source
PageSize
Declaration
public PageSizeType PageSize { get; set; }
Property Value
View Source
PageSizeIndex
Page size index if applicable, when it matchs the Windows GDI page size indexes
Declaration
public int PageSizeIndex { get; set; }
Property Value
View Source
PageWidth
Declaration
public int PageWidth { get; set; }
Property Value
View Source
PaperSource
Declaration
public int PaperSource { get; set; }
Property Value
View Source
Params
Report parameters collection
Declaration
public Params Params { get; set; }
Property Value
View Source
PreviewAbout
Declaration
public bool PreviewAbout { get; set; }
Property Value
View Source
PreviewMargins
Declaration
public bool PreviewMargins { get; set; }
Property Value
View Source
PreviewWindow
Default window size when the preview is executed
Declaration
public PreviewWindowStyleType PreviewWindow { get; set; }
Property Value
View Source
PrintOnlyIfDataAvailable
Declaration
public bool PrintOnlyIfDataAvailable { get; set; }
Property Value
View Source
PrintStep
Declaration
public PrintStepType PrintStep { get; set; }
Property Value
View Source
PrinterFonts
Declaration
public PrinterFontsType PrinterFonts { get; set; }
Property Value
View Source
PrinterSelect
Declaration
public PrinterSelectType PrinterSelect { get; set; }
Property Value
View Source
RecordCount
Number of records processed by the main dataset in the current subreport
Declaration
[JsonIgnore]
[JsonIgnore]
public int RecordCount { get; }
Property Value
View Source
RightMargin
Declaration
public int RightMargin { get; set; }
Property Value
View Source
SingleLine
Declaration
public bool SingleLine { get; set; }
Property Value
View Source
Declaration
public StreamFormatType StreamFormat { get; set; }
Property Value
View Source
SubReports
Declaration
public SubReports SubReports { get; set; }
Property Value
View Source
TopMargin
Declaration
public int TopMargin { get; set; }
Property Value
View Source
Transparent
Declaration
public bool Transparent { get; set; }
Property Value
View Source
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
View Source
Type1Font
Declaration
public PDFFontType Type1Font { get; set; }
Property Value
View Source
VAlignment
Declaration
public TextAlignVerticalType VAlignment { get; set; }
Property Value
View Source
WFontName
Windows font name, that is the default font name while designing the report scheme
Declaration
public string WFontName { get; set; }
Property Value
View Source
WordWrap
Declaration
public bool WordWrap { get; set; }
Property Value
Methods
View Source
ActivateDatasets()
Declaration
protected void ActivateDatasets()
View Source
AddComponent(ReportItem)
Declaration
public void AddComponent(ReportItem it)
Parameters
View Source
AddReportItemsToEvaluator(Evaluator)
Declaration
public void AddReportItemsToEvaluator(Evaluator eval)
Parameters
View Source
AddSubReport()
Declaration
public SubReport AddSubReport()
Returns
View Source
AddTotalPagesItem(int, int, string)
Declaration
public void AddTotalPagesItem(int apageindex, int aobjectindex, string adisplayformat)
Parameters
| Type |
Name |
Description |
| int |
apageindex |
|
| int |
aobjectindex |
|
| string |
adisplayformat |
|
View Source
AlignSectionsTo(int)
Declaration
public void AlignSectionsTo(int linesPerInch)
Parameters
| Type |
Name |
Description |
| int |
linesPerInch |
|
View Source
BeginPrint(PrintOut)
Declaration
public virtual void BeginPrint(PrintOut driver)
Parameters
View Source
CheckIfDataAvailable()
Declaration
protected void CheckIfDataAvailable()
View Source
CheckParameters()
Declaration
public string CheckParameters()
Returns
View Source
CheckProgress(bool)
Internal progress procedure
Declaration
protected void CheckProgress(bool finished)
Parameters
| Type |
Name |
Description |
| bool |
finished |
When finished calls an event if assigned
|
View Source
ConvertToDotNet()
Converts a report to dot net, changing data driver type and parameters in sql sentences
Declaration
public void ConvertToDotNet()
View Source
CreateNew()
Declaration
View Source
DeActivateDatasets()
Declaration
protected void DeActivateDatasets()
View Source
DeleteComponent(ReportItem)
Declaration
public void DeleteComponent(ReportItem item)
Parameters
View Source
DeleteComponentPrintPosItem(Section, PrintPosItem, int, int)
Declaration
public void DeleteComponentPrintPosItem(Section section, PrintPosItem compo, int index, int groupId)
Parameters
View Source
DeleteComponents(Section, int)
Declaration
public void DeleteComponents(Section section, int groupId)
Parameters
View Source
DeleteItem(ReportItem, int)
Declaration
public void DeleteItem(ReportItem item, int groupId)
Parameters
View Source
DeleteSubReport(SubReport)
Declaration
public void DeleteSubReport(SubReport sub)
Parameters
View Source
Dispose()
Declaration
View Source
DoUpdatePageSize(MetaPage, PageSizeDetail)
Declaration
public void DoUpdatePageSize(MetaPage MetaFilepage, PageSizeDetail detail)
Parameters
View Source
EndPrint()
Declaration
View Source
EnsureComponentNames()
Ensures all components have valid names. Generates names for components without one.
Call this after loading a report template to ensure undo/redo works correctly.
This is needed because in older versions, DataInfo, DatabaseInfo and Param did not have names.
Declaration
public void EnsureComponentNames()
View Source
Declaration
protected void FillGlobalHeaders()
View Source
FindNewName(ReportItem)
Find new name for a report item
Declaration
public string FindNewName(ReportItem ritem)
Parameters
Returns
View Source
GenerateNewName(ReportItem)
Create a new name for a report item
Declaration
public void GenerateNewName(ReportItem ritem)
Parameters
View Source
GetParentSection(PrintPosItem)
Declaration
public Section GetParentSection(PrintPosItem item)
Parameters
Returns
View Source
GetParentSubReport(Section)
Declaration
public SubReport GetParentSubReport(Section section)
Parameters
| Type |
Name |
Description |
| Section |
section |
|
Returns
View Source
GetReportVariables()
Obtain a list of available identifiers that can be used in a expression
inside Evaluator class
Declaration
public Strings GetReportVariables()
Returns
View Source
InitEvaluator()
Declaration
public void InitEvaluator()
View Source
InitializeParams()
Declaration
public void InitializeParams()
View Source
LoadFromCommand(IDbCommand)
Declaration
public void LoadFromCommand(IDbCommand selecommand)
Parameters
View Source
LoadFromDataReader(IDataReader)
Declaration
public void LoadFromDataReader(IDataReader areader)
Parameters
View Source
LoadFromFile(string)
Declaration
public void LoadFromFile(string filename)
Parameters
| Type |
Name |
Description |
| string |
filename |
|
View Source
LoadFromStream(Stream, bool)
Declaration
public void LoadFromStream(Stream astream, bool convertToDotNet = true)
Parameters
| Type |
Name |
Description |
| Stream |
astream |
|
| bool |
convertToDotNet |
|
View Source
LoadFromStream(Stream, int)
Declaration
public void LoadFromStream(Stream astream, int bufsize)
Parameters
| Type |
Name |
Description |
| Stream |
astream |
|
| int |
bufsize |
|
View Source
NewComponentByClassName(string)
Declaration
public static ReportItem NewComponentByClassName(string className)
Parameters
| Type |
Name |
Description |
| string |
className |
|
Returns
View Source
PrepareParamsAfterOpen()
Declaration
protected void PrepareParamsAfterOpen()
View Source
PrepareParamsBeforeOpen()
Declaration
protected void PrepareParamsBeforeOpen()
View Source
PrintAll(PrintOut)
Declaration
public void PrintAll(PrintOut Driver)
Parameters
View Source
PrintNextPage()
Declaration
public abstract bool PrintNextPage()
Returns
View Source
RemoveComponent(ReportItem)
Declaration
public void RemoveComponent(ReportItem it)
Parameters
View Source
RequestPage(int)
Declaration
public bool RequestPage(int pageindex)
Parameters
| Type |
Name |
Description |
| int |
pageindex |
|
Returns
View Source
SaveToFile(string, StreamVersion)
Declaration
public void SaveToFile(string filename, StreamVersion version = StreamVersion.V2)
Parameters
View Source
SaveToStream(Stream, StreamVersion)
Declaration
public void SaveToStream(Stream astream, StreamVersion version = StreamVersion.V2)
Parameters
View Source
SubreportMustBeExecuted(SubReport)
Declaration
public bool SubreportMustBeExecuted(SubReport nsubreport)
Parameters
Returns
View Source
UpdateParamsAfterOpen(int, bool)
Declaration
protected void UpdateParamsAfterOpen(int index, bool doeval)
Parameters
| Type |
Name |
Description |
| int |
index |
|
| bool |
doeval |
|
View Source
UpdateParamsBeforeOpen(int, bool)
Declaration
public void UpdateParamsBeforeOpen(int index, bool doeval)
Parameters
| Type |
Name |
Description |
| int |
index |
|
| bool |
doeval |
|
View Source
UpdateReferences()
Declaration
public void UpdateReferences()
Events
View Source
OnProgress
Event to track the report progress and cancel the progress if needed
Declaration
public event ReportProgress OnProgress
Event Type
View Source
OnWorkAsyncError
Event to track report errors
Declaration
public event MetaFileWorkAsyncError OnWorkAsyncError
Event Type
View Source
OnWorkProgress
Event to track report progress
Declaration
public event MetaFileWorkProgress OnWorkProgress
Event Type
Implements