FourJs.Report.Runtime.RTFRenderer Class Reference

Class for configuring RTF output. More...

Inheritance diagram for FourJs.Report.Runtime.RTFRenderer:

Public Types
enum	OutputFormat { RTF, OORTF }
enum	ImageFormat { png, jpg }

Public Member Functions
	RTFRenderer (FormatHandler handler)
	Creates a RTFRenderer object that outputs to the given handler object. More...
Public Member Functions inherited from FourJs.Report.Runtime.FormatProducer
	FormatProducer (FormatHandler handler)
	Creates a FormatProducer object that outputs to the given handler object. More...

Static Public Attributes
static String	legalCopyright = Version.CLASS_COPYRIGHT
Static Public Attributes inherited from FourJs.Report.Runtime.FormatProducer
static String	legalCopyright = Version.CLASS_COPYRIGHT

Properties
int	fromPage [get, set]
	Sets the first page to be included in the document. fromPage an integer greater than zero and less than or equal to toPage More...
int	toPage [get, set]
	Sets the last page (inclusive) to be included in the document. toPage an integer greater than zero and less than or equal to fromPage More...
int	maximumImageResolution [get, set]
	Sets the maximum DPI of images included in the document. More...
ImageFormat	imageFormat [get, set]
	Sets the image format of images contained in the document as determined by the imageFormat argument. More...
int	memoryThreshold [get, set]
	Sets the threshold for disk swapping. Documents exceeding the value will be processed using a temporary file thereby reducing the amount of heap space used for processing. More...
OutputFormat	outputFormat [get, set]
	Sets the output format as determined by the outputFormat argument. More...
Properties inherited from FourJs.Report.Runtime.FormatProducer
FormatHandler	handler [get]
	Sets the specified handler as the handler for the output produced by this processor. More...

Detailed Description

Class for configuring RTF output.

Font embedding

Fonts are not embedded in the output.

Faithfulness of output

The focus for the RTF output is on the alterability of content. For faithful reproduction consider using the PDFRenderer, SVGRenderer, PostscriptRenderer, Printer or ImageRenderer.

Processing large documents

For documents not containing "Page N of M" paginations the delay between input and output is one page and memory consumption is nearly constant. For documents containing "Page N of M" paginations the latency is M pages and the memory consumption is linear within a pagination block and hence can exhaust heap space if individual blocks are very large.

Constructor & Destructor Documentation

FourJs.Report.Runtime.RTFRenderer.RTFRenderer

(

FormatHandler

handler

)

Creates a RTFRenderer object that outputs to the given handler object.

Parameters

handler

Property Documentation

int FourJs.Report.Runtime.RTFRenderer.fromPage

getset

Sets the first page to be included in the document. fromPage an integer greater than zero and less than or equal to toPage

Exceptions

ArgumentOutOfRangeException

if the above condition is violated.

ImageFormat FourJs.Report.Runtime.RTFRenderer.imageFormat

getset

Sets the image format of images contained in the document as determined by the imageFormat argument.

int FourJs.Report.Runtime.RTFRenderer.maximumImageResolution

getset

Sets the maximum DPI of images included in the document.

Exceptions

ArgumentOutOfRangeException

if maximumImageResolutionInDPI is not greater than 0.

int FourJs.Report.Runtime.RTFRenderer.memoryThreshold

getset

Sets the threshold for disk swapping. Documents exceeding the value will be processed using a temporary file thereby reducing the amount of heap space used for processing.

Exceptions

ArgumentOutOfRangeException

if memoryThresholdInBytes is not greater than 0.

OutputFormat FourJs.Report.Runtime.RTFRenderer.outputFormat

getset

Sets the output format as determined by the outputFormat argument.

int FourJs.Report.Runtime.RTFRenderer.toPage

getset

Sets the last page (inclusive) to be included in the document. toPage an integer greater than zero and less than or equal to fromPage

Exceptions

ArgumentOutOfRangeException

if the above condition is violated.