VReport Class: Printing Methods

VReport.PrintToDisk()

Declaration:

PrintToDisk( 
    inLocation       as FolderItem, 
    inPrintType      as EVReportPrintType,
    inStartPageIndex as UINT = 0,
    inEndPageIndex   as UINT = 0  )

Parameters:

inLocation - The location for the generated file.
inPrintType - Specifies the format of the generated report.
inStartPageIndex - The index of the first page to be printed (1..N). Zero to print all pages of the report.
inEndPageIndex - The index of the last page to be printed (1..N).

Description:

Prints all pages or the specified range of pages of the report to the disk file at the given location.

You can specify the format of the produced file with the help of the inPrintType parameter. Valid values for this parameter are enumerated in the EVReportPrintType enum type. Usually you will use these values as kToPDF, kToHTML, kToPicture_JPG.

Example:

theReport.PrintToDisk( "report_1.html", EVReportPrintType.kToHTML )

VReport.PrintToBuffer()

Declaration:

PrintToBuffer( 
    inPrintType      as EVReportPrintType,
    inStartPageIndex as UINT = 0, 
    inEndPageIndex   as UINT = 0 ) as BinaryData

Parameters:

inPrintType - Specifies the format of generated report.
inStartPageIndex - the index of the first page to be printed (1..N). Zero to print all records of the report.
inEndPageIndex - the index of the last page to be printed (1..N).

Description:

Prints all pages or the specified range of pages of the report to the memory buffer and returns it. You can specify the format of the produced file through the inPrintType parameter. Valid values for this parameter are enumerated in the EVReportPrintType enum type. Usually you will use these values as kToPDF, kToHTML, kToPicture_JPG.

NOTE: There are different types of BinaryData for different programming languages. For example for REALbasic or PHP this is String because it can keep binary data, for Obj-C this is NSData, and so on. See the example(s) of work with Report class in your Valentina ADK for details.

Example:

dim report as BinaryData
 
report = theReport.PrintToBuffer( EVReportPrintType.kToPDF, 1, 10 )

VReport.PrintToLocalPrinter()

Declaration:

PrintToLocalPrinter( 
    inPrinter        as String = "",
    inOptions        as String = "",
    inStartPageIndex as UINT   = 0, 
    inEndPageIndex   as UINT   = 0 )

Parameters:

inPrinter - Specifies the target local printer. Empty to print to a default printer.
inOptions - Specifies the printing options. Empty to use defaults.
inStartPageIndex - the index of the first page to be printed (1..N). Zero to print all records of the report.
inEndPageIndex - the index of the last page to be printed (1..N).

Description:

Prints all pages or the specified range of pages of the report to the given printer.

You can specify the printing options to tune the printer output in format:

option1=value1,option2=value2,...

Common printing options

collate - Specifies whether collation should be used when printing multiple copies. Possible values: yes, no.
copies - Selects the number of copies printed if the device supports multiple-page copies.
duplex - Selects duplex or double-sided printing for printers capable of duplex printing. Possible values: yes, no.
landscape - Selects the landscape orientation of the paper. Possible values: yes, no.
paper - Selects the name of the paper format to print on. For example, 'paper=A4'.
reverse - This option will print the pages in reverse order. Possible values: yes, no.
scaling - Specifies the factor by which the printed output is to be scaled. The apparent page size is scaled from the physical page size by a factor of scaling / 100. For example, 'scaling=50'.

Examples:

theReport.PrintToLocalPrinter( "LBP3000", "paper=A4" );
theReport.PrintToLocalPrinter( "LBP3000", "paper=A2", 1, 5 );
theReport.PrintToLocalPrinter( "LBP3000", "paper=A4,landscape=yes,copies=2" );

Additional printing options for OS X and Linux

On OS X and Linux systems CUPS library is used for printing therefore it is possible to specify any of it's options.

fit-to-page - Specifies that the document should be scaled to fit on the page. Possible values: yes, no.
number-up-default - Specifies the number of pages to print on each output page.

NOTE: Complete set of supported options with their descriptions can be found here.

Examples:

theReport.PrintToLocalPrinter( "LBP3000", "paper=A4,fit-to-page=yes" );
theReport.PrintToLocalPrinter( "LBP3000", "paper=A4,landscape=yes,fit-to-page=yes,copies=2" );
theReport.PrintToLocalPrinter( "LBP3000", "paper=A3,page-set=odd" );

Additional printing options for Windows

In addition to common properties, on Windows the following options can be used:

color - Switches between color and monochrome on color printers. The following are the possible values: yes, no.
paperlength - Specifies the length of the page in millimeters.
paperwidth - Specifies the width of the page in millimeters.
papersize - Selects the size of the paper to print on. This option can be set to a device specific value or to one of the following predefined values.

Papersize predefined values

Value	Meaning
1	US Letter 8 1/2 x 11 in
2	US Letter Small 8 1/2 x 11 in
3	US Tabloid 11 x 17 in
4	US Ledger 17 x 11 in
5	US Legal 8 1/2 x 14 in
6	US Statement 5 1/2 x 8 1/2 in
7	US Executive 7 1/4 x 10 1/2 in
8	A3 297 x 420 mm
9	A4 210 x 297 mm
10	A4 Small 210 x 297 mm
11	A5 148 x 210 mm
12	B4 (JIS) 257 x 364 mm
13	B5 (JIS) 182 x 257 mm
14	Folio 8 1/2 x 13 in
15	Quarto 215 x 275 mm
16	10 x 14 in
17	11 x 17 in
18	US Note 8 1/2 x 11 in
19	US Envelope #9 3 7/8 x 8 7/8
20	US Envelope #10 4 1/8 x 9 1/2
21	US Envelope #11 4 1/2 x 10 3/8
22	US Envelope #12 4 3/4 x 11 in
23	US Envelope #14 5 x 11 1/2
24	C size sheet
25	D size sheet
26	E size sheet
27	Envelope DL 110 x 220mm
28	Envelope C5 162 x 229 mm
29	Envelope C3 324 x 458 mm
30	Envelope C4 229 x 324 mm
31	Envelope C6 114 x 162 mm
32	Envelope C65 114 x 229 mm
33	Envelope B4 250 x 353 mm
34	Envelope B5 176 x 250 mm
35	Envelope B6 176 x 125 mm
36	Envelope 110 x 230 mm
37	US Envelope Monarch 3.875 x 7.5 in
38	6 3/4 US Envelope 3 5/8 x 6 1/2 in
39	US Std Fanfold 14 7/8 x 11 in
40	German Std Fanfold 8 1/2 x 12 in
41	German Legal Fanfold 8 1/2 x 13 in
42	B4 (ISO) 250 x 353 mm
43	Japanese Postcard 100 x 148 mm
44	9 x 11 in
45	10 x 11 in
46	15 x 11 in
47	Envelope Invite 220 x 220 mm
48	RESERVED–DO NOT USE
49	RESERVED–DO NOT USE
50	US Letter Extra 9 1/2 x 12 in
51	US Legal Extra 9 1/2 x 15 in
52	US Tabloid Extra 11.69 x 18 in
53	A4 Extra 9.27 x 12.69 in
54	Letter Transverse 8 1/2 x 11 in
55	A4 Transverse 210 x 297 mm
56	Letter Extra Transverse 9 1/2 x 12 in
57	SuperA/SuperA/A4 227 x 356 mm
58	SuperB/SuperB/A3 305 x 487 mm
59	US Letter Plus 8.5 x 12.69 in
60	A4 Plus 210 x 330 mm
61	A5 Transverse 148 x 210 mm
62	B5 (JIS) Transverse 182 x 257 mm
63	A3 Extra 322 x 445 mm
64	A5 Extra 174 x 235 mm
65	B5 (ISO) Extra 201 x 276 mm
66	A2 420 x 594 mm
67	A3 Transverse 297 x 420 mm
68	A3 Extra Transverse 322 x 445 mm
69	Japanese Double Postcard 200 x 148 mm
70	A6 105 x 148 mm
71	Japanese Envelope Kaku #2
72	Japanese Envelope Kaku #3
73	Japanese Envelope Chou #3
74	Japanese Envelope Chou #4
75	Letter Rotated 11 x 8 1/2 11 in
76	A3 Rotated 420 x 297 mm
77	A4 Rotated 297 x 210 mm
78	A5 Rotated 210 x 148 mm
79	B4 (JIS) Rotated 364 x 257 mm
80	B5 (JIS) Rotated 257 x 182 mm
81	Japanese Postcard Rotated 148 x 100 mm
82	Double Japanese Postcard Rotated 148 x 200 mm
83	A6 Rotated 148 x 105 mm
84	Japanese Envelope Kaku #2 Rotated
85	Japanese Envelope Kaku #3 Rotated
86	Japanese Envelope Chou #3 Rotated
87	Japanese Envelope Chou #4 Rotated
88	B6 (JIS) 128 x 182 mm
89	B6 (JIS) Rotated 182 x 128 mm
90	12 x 11 in
91	Japanese Envelope You #4
92	Japanese Envelope You #4 Rotated
93	PRC 16K 146 x 215 mm
94	PRC 32K 97 x 151 mm
95	PRC 32K(Big) 97 x 151 mm
96	PRC Envelope #1 102 x 165 mm
97	PRC Envelope #2 102 x 176 mm
98	PRC Envelope #3 125 x 176 mm
99	PRC Envelope #4 110 x 208 mm
100	PRC Envelope #5 110 x 220 mm
101	PRC Envelope #6 120 x 230 mm
102	PRC Envelope #7 160 x 230 mm
103	PRC Envelope #8 120 x 309 mm
104	PRC Envelope #9 229 x 324 mm
105	PRC Envelope #10 324 x 458 mm
106	PRC 16K Rotated
107	PRC 32K Rotated
108	PRC 32K(Big) Rotated
109	PRC Envelope #1 Rotated 165 x 102 mm
110	PRC Envelope #2 Rotated 176 x 102 mm
111	PRC Envelope #3 Rotated 176 x 125 mm
112	PRC Envelope #4 Rotated 208 x 110 mm
113	PRC Envelope #5 Rotated 220 x 110 mm
114	PRC Envelope #6 Rotated 230 x 120 mm
115	PRC Envelope #7 Rotated 230 x 160 mm
116	PRC Envelope #8 Rotated 309 x 120 mm
117	PRC Envelope #9 Rotated 324 x 229 mm
118	PRC Envelope #10 Rotated 458 x 324 mm

printquality - Specifies the printer resolution. There are four predefined device-independent values:

Value	Meaning
-4	High
-3	Medium
-2	Low
-1	Draft

If a positive value is specified, it specifies the number of dots per inch (DPI) and is therefore device dependent.

papersource - Specifies the paper source.

It can be one of the following values, or it can be a device-specific value greater than or equal to User source constant value.

Value	Source
1	First, Upper, Only One
2	Lower
3	Middle
4	Manual
5	Envelope
6	Envelope Manual
7	Auto
8	Tractor
9	Small Format
10	Large Format
11	Large Capacity
14	Casette
15	Form Source, Last
256	User

Valentina Client printing details

VClient-based application running on different OS prints reports to local printer differently:

On Windows a custom-format vector file is generated at server side, transferred via the network and passed into VREPORT.DLL for printing.
On OS X and Linux a PDF file is generated at server side, transferred via the network, saved locally and passed into CUPS library for printing.

VReport.PrintToServerPrinter()

Declaration:

PrintToServerPrinter( 
    inPrinter        as String = "",
    inOptions        as String = "",
    inStartPageIndex as UINT   = 0, 
    inEndPageIndex   as UINT   = 0 )

Parameters:

inPrinter - Specifies the target printer in the system, where Valentina Server is running. Empty to print to a default printer.
inOptions - Specifies the printing options. Empty to use defaults.
inStartPageIndex - the index of the first page to be printed (1..N). Zero to print all records of the report.
inEndPageIndex - the index of the last page to be printed (1..N).

Description:

If the Valentina Server is used for reports generation, this method prints all pages or the specified range of pages of the report to the given printer, installed in the system, where server is running.

You can specify the printing options to tune the printer output in format:

option1=value1,option2=value2,...

NOTE: Learn more about available options in the description of VReport.PrintToLocalPrinter() method.

Table of Contents

VReport Class: Printing Methods

VReport.PrintToDisk()

VReport.PrintToBuffer()

VReport.PrintToLocalPrinter()

Common printing options

Additional printing options for OS X and Linux

Additional printing options for Windows

Valentina Client printing details

VReport.PrintToServerPrinter()