C# Class Reports.ReportHandler

Class contain the base information for report configs (Name of the report, the path of the generated .pdf and the dictionary)
Inheritance: Utils.ProgressHandler
Mostra file Open project: ERTMSSolutions/ERTMSFormalSpecs Class Usage Examples

Public Methods

Method Description
BuildDocument ( ) : MigraDoc.DocumentObjectModel.Document

This method must be implemented to create the document contents

ExecuteWork ( ) : void

Generates the file in the background thread

Protected Methods

Method Description
CleanTempFiles ( ) : void

Removes all temporary files

CreateFileName ( string title ) : void

Creates the full file name from a given title

CreateTempFile ( string extension ) : string

Creates a temporary file, with the provided extension

GenerateOutputFile ( MigraDoc.DocumentObjectModel.Document document ) : bool

Produces the .pdf corresponding to the book, according to user's choices specified in the report config

ReportHandler ( DataDictionary.Dictionary dictionary ) : System

Constructor

Method Details

BuildDocument() public abstract method

This method must be implemented to create the document contents
public abstract BuildDocument ( ) : MigraDoc.DocumentObjectModel.Document
return MigraDoc.DocumentObjectModel.Document

CleanTempFiles() protected method

Removes all temporary files
protected CleanTempFiles ( ) : void
return void

CreateFileName() protected method

Creates the full file name from a given title
protected CreateFileName ( string title ) : void
title string Name of the report
return void

CreateTempFile() protected method

Creates a temporary file, with the provided extension
protected CreateTempFile ( string extension ) : string
extension string
return string

ExecuteWork() public method

Generates the file in the background thread
public ExecuteWork ( ) : void
return void

GenerateOutputFile() protected method

Produces the .pdf corresponding to the book, according to user's choices specified in the report config
protected GenerateOutputFile ( MigraDoc.DocumentObjectModel.Document document ) : bool
document MigraDoc.DocumentObjectModel.Document The document to be created
return bool

ReportHandler() protected method

Constructor
protected ReportHandler ( DataDictionary.Dictionary dictionary ) : System
dictionary DataDictionary.Dictionary
return System