Four Js Genero Report Writer
FourJs.Report.Runtime.StreamingClientNamedPrinter Class Reference

Class for configuring output to the streaming client selecting a specific printer by name and configuring it. More...

Inheritance diagram for FourJs.Report.Runtime.StreamingClientNamedPrinter:
FourJs.Report.Runtime.AbstractStreamingClient FourJs.Report.Runtime.LayoutedPagesConsumer

Public Member Functions

 StreamingClientNamedPrinter (String printerName)
 

Static Public Attributes

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

Properties

String printerName [get, set]
 Selects a printer by name. A printer name as listed by the command line utility "printerinfo" from the GDC package. More...
 
String paperSource [get, set]
 Selects a paper source by name. A paper source as listed by the command line utility "printerinfo" from the GDC package. More...
 
int copies [get, set]
 Specifies the number of copies. The default value is 1. copies an integer greater than 0. More...
 
int printFromPage [get, set]
 Sets the first page to be printed. fromPage an integer greater than zero and less than or equal to toPage. More...
 
int printToPage [get, set]
 Sets the last page (inclusive) to be printed. toPage an integer greater than zero and less than or equal to fromPage. More...
 
bool sheetCollate [get, set]
 Activates sheet collation if true. The default value is false. If set, each copy of each document is printed with the print-stream sheets in sequence. When sheet collation isn't set, each print-stream sheet is printed a number of times equal to the value of the copies value in succession. For example, suppose a document produces two media sheets as output, copies is 6, and sheet collation is not set. In this case six copies of the first page are printed followed by six copies of the second page and so forth. The default value is false. More...
 
override String previewType [get]
 
- Properties inherited from FourJs.Report.Runtime.AbstractStreamingClient
abstract String previewType [get]
 
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 first page to be included in the document. fromPage an integer greater than zero and less than or equal to toPage More...
 
bool embedFonts [get, set]
 Activates font embedding if true, external font referencing if false. The default value is true. embedFonts whether fonts are embedded in the document or external references are used More...
 
String charsetToEmbed [get, set]
 Selects a character set for font embedding whose characters will be embedded (if available in the selected fonts). The default value is "DEFAULT". More...
 
Orientation orientationRequested [get, set]
 Informs the renderer of the orientation of the paper in the printer as determined by the orientationRequested argument. Some printers (typically matrix printers) allow can be loaded with both landscape and portrait paper sheets. For most printers however the printer driver is not aware of the orientation of the paper sheets and so the jobs misprint on one of the two paper types (typically landscape). Calling this function allows to fix this deficiency manually. More...
 
bool compressOutput [get, set]
 Indicates whether or not the output will be compressed. Output compression is disabled by default. More...
 
Client client [get, set]
 Sets the client application as determined by the client argument. More...
 
String clientHost [get, set]
 Sets the host name of the remote client application. The default value is parsed from the environment variables FGLSERVER or GRWSERVER in this order. The variables are expected to follow the syntax "host:port" (same syntax as the DISPLAY variable of X Windows). If neither of them are set the default value "localhost" is used. More...
 
int clientPort [get, set]
 Sets the port number at which the client application is listening. The value is expected to be a unsigned 16 bit value. The default value is parsed from the environment variables FGLSERVER or GRWSERVER in this order. if The variables are expected to follow the syntax "host:port" (same syntax as the DISPLAY variable of X Windows). If neither of them are set the default value 6400 is used for GDC and 6401 is used for GRV. clientPort The port number at which the remote application is listening. More...
 

Additional Inherited Members

- Public Types inherited from FourJs.Report.Runtime.AbstractStreamingClient
enum  Orientation { landscape, portrait }
 
enum  Client { GDC, GRV }
 

Detailed Description

Class for configuring output to the streaming client selecting a specific printer by name and configuring it.

Streaming Client

The streaming client option requires the streaming client component GRV (Genero report viewer) or GDC (Genero desktop client) to be up and running.

Property Documentation

int FourJs.Report.Runtime.StreamingClientNamedPrinter.copies
getset

Specifies the number of copies. The default value is 1. copies an integer greater than 0.

Exceptions
ArgumentOutOfRangeExceptionif copies is less than or equal to 0
String FourJs.Report.Runtime.StreamingClientNamedPrinter.paperSource
getset

Selects a paper source by name. A paper source as listed by the command line utility "printerinfo" from the GDC package.

String FourJs.Report.Runtime.StreamingClientNamedPrinter.printerName
getset

Selects a printer by name. A printer name as listed by the command line utility "printerinfo" from the GDC package.

int FourJs.Report.Runtime.StreamingClientNamedPrinter.printFromPage
getset

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

Exceptions
ArgumentOutOfRangeExceptionif the above condition is violated
int FourJs.Report.Runtime.StreamingClientNamedPrinter.printToPage
getset

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

Exceptions
ArgumentOutOfRangeExceptionif the above condition is violated
bool FourJs.Report.Runtime.StreamingClientNamedPrinter.sheetCollate
getset

Activates sheet collation if true. The default value is false. If set, each copy of each document is printed with the print-stream sheets in sequence. When sheet collation isn't set, each print-stream sheet is printed a number of times equal to the value of the copies value in succession. For example, suppose a document produces two media sheets as output, copies is 6, and sheet collation is not set. In this case six copies of the first page are printed followed by six copies of the second page and so forth. The default value is false.