Page History
...
| Parameter | Description of Fields | Comments | Default |
|---|---|---|---|
| Parm1 - FileName | <1> FileName | Process FileName | "Printing" |
| <2> Load RTF | RTF filename to load | "" | |
| <3> Export Format | 0 = No export 1 = RTF 2 = HTML 3 = DHTML 4 = HTML with pages 5 = DHTML with pages 6 = PDF 7 = CSV with header 8 = CSV without header 9 = TXT file 10 = OIPI Print File 11 = Archive Reports | 0 | |
| <4> Export File Name | File name for the export or Archive Name | "" | |
| <5, 1> PDF Owner password | Note: Applies to OIPI.Net only with Patch v4 or higher. Password that allows permission changes to the PDF document. | "" | |
| <5, 2> PDF User password | Note: Applies to OIPI.Net only with Patch v4 or higher. Password that only allows the opening of the PDF document. | "" | |
| <5, 3> PDF Permissions | Note: Applies to OIPI.Net only with Patch v4 or higher. String of single character flags that indicate what permissions are granted to the PDF document: C = Copy E = Edit P = Print A = Annotation Edit | "" | |
| Parm2 - Title | <1> Print Title | "Title String" | "Printing" |
| <2> Preview Title | Must be an unique string | "Print Preview" | |
| <3> Cancel Button Text | Use "&" to underline a specific character | "&Cancel" | |
| <4> Device Text | The first "%s" is printer name and the second "%s" is the port name | "on the %s on %s" | |
| <5> Page Text | The "%d" is the current page number | "Now Printing Page %d of" | |
| Parm3 - PageInfo | <1> LeftMargin | Left margin | 0.5 |
| <2> TopMargin | Top margin | 0.5 | |
| <3> RightMargin | Right margin | 0.5 | |
| <4> BottomMargin | Bottom margin | 0.5 | |
| <5> PageWidth | Page Width in inches | 8.5 | |
| <6> PageHeight | Page Height in inches | 11.0 | |
| <7> PageSize | See OIPRINT_EQUATES | ||
| <8> Copies | Number of copies to print | ||
| <9> Shortcuts | 0=None 1=Copy to clipboard | 0 | |
| Parm4 - PageSetup | <1> Orientation | 0=Port 1=Land | "" |
| <2> Units | 1=Inches 2=Mm 3=cm 4=twips 5=points | ||
| <3, 1> Export Top Navigation | Customizes the navigation at the top of the exported pages | "" | |
| <3, 2> Export Bottom Navigation | Customizes the navigation at the bottom of the exported pages | "" | |
| <4, 1> Columns | Number of columns in the report | ||
| <4, 2> ColumnSpacing | Spacing between columns | 0.125 | |
| Parm5 - PrintSetup | <1, 1> Style | 0=Print to printer 1=Display PrintSetup 2=Preview normal 3=Maximized 4=Last location 5=Specific location 99=Print to printer with the WMF Fix. | 0 |
| <1, 2> Buttons | 0=Display All Buttons 1=Display Print Setup Button Only 2=Display Print Button Only 3=Hide All Buttons 4=Display PDF Button Only 5=Display Print and PDF Buttons 6=Display Print and Print Setup Buttons | 2 | |
| <1, 3> Hide | 0=Display 1=Hide the Printing Window | 0 | |
| <1, 4> StartMode | 0=Normal 1=Minimized 2=Hidden 3=Completely Hidden | 0 | |
| <1, 5> AllowPageRange | 0=No Page Range 1=Page Range Dialog Box | 0 | |
| <1, 6> Mouse Support | 0=No support 1=Mouse 2=Mouse wheel 3=Mouse and wheel 4=Keyboard 5=Mouse and keyboard 6=Wheel and keyboard 7=All | 0 | |
| <2> Zoom | >0=Zoom -1=Page Width -2=Whole Page | 100 | |
| <3> SpecificX1 | to 100% | 0 | |
| <4> SpecificY1 | to 100% | 0 | |
| <5> SpecificX2 | to 100% | 0 | |
| <6> SpecificY2 | to 100% | 0 | |
| <7> Duplex | 1= Simplex 2=Horizontal Duplex 3= Vertical Duplex | 1 | |
| <8> Hidden Export Formats | Export Format. When the Export Formats window is launched from the Preview window, it is possible to disable the export to specific formats. Set the specific values to 1 within this parameter to disable the format. Note: Applies to OpenInsight Versions 8.0 and above. | "" | |
| <8,1>PDF | Set to 1 to disable option. | "" | |
| <8,2>RTF | Set to 1 to disable option. | "" | |
| <8,3> Save Report | Set to 1 to disable option. | "" | |
| <8,4> Load Report | Set to 1 to disable option. | "" | |
| <8,5> CSV | Set to 1 to disable option. | "" | |
| <8,6> Archive | Set to 1 to disable option. | "" | |
| <8,7> N/A | N/A | "" | |
| <8,8> HTML | Set to 1 to disable option. | "" | |
| <9>Backcolor | Preview window background color. An RGB number is expected. | "" | |
| Parm6 - Printer | <1,1> Device | Device String | "" |
| <1,2> Default Printer | Boolean. When set to true the Windows default printer will be changed to the printer specified in the Device parameter. | "" | |
| <2> Port | Port String | "" | |
| <3> ScaleOutput | Scales the output to the printer | 100 | |
| <4> Bin | Bin Number | "" | |
| Parm7 - CharMap | CharMap | 510 bytes | "" |
| Parm8 - Image Display | In the Preview window, custom images may be used for the icons on the OIPI standard buttons. Note: Applies to OpenInsight Versions 8.0 and above. | ||
| <1,1> | Print Dialog Button | "" | |
| <1,2> | Print Button | "" | |
| <1,3> | Export Format Button | "" | |
| <1,4> | First Page Arrow Button | "" | |
| <1,5> | Prev Page Arrow Button | "" | |
| <1,6> | Next Page Arrow Button | "" | |
| <1,7> | Last Page Arrow Button | "" | |
| <1,8> | FInd Button | "" | |
| <1,9> | Close Button | "" | |
| Parm9 - Pagebreak Programs | Stored Procedures to call prior to and after the printer control executes its Pagebreak. Note: Applies to OpenInsight Versions 8.0.2 and above. | ||
| <1,1> | The name of the program to execute prior to the printer control executing a page break. | "" | |
| <1,2> | The name of the program to execute after the printer control executes a page break. | "" |
...
The FileName parameter is printed in the header and footer when the 'F' code is used, and it is used to identify the print job from the Printer Manager. If you are using OIPI.Net with Patch v4, then you can use the PDF password and permissions options. Here is an example of what the FileName parameter might look like using the PDF enhancements:
| Code Block |
|---|
parm1<1> = "Report 1" parm1<3> = 6 parm1<4> = "c:\temp\samplepdf.pdf" parm1<5> = "bzs":@VM:"bryan":@VM:"EC" |
...
This specifies the title is “Report 1”, I wish to generate a PDF (type 6), the PDF name is “c:\temp\samplepdf.pdf”, and it has a PDF owner’s password of “bzs”, a PDF user’s password of “bryan”, and both Edit and Copy permissions are granted.
...
The PageWidth, PageHeight, and PageSize parameters are used to set the page height and width for the current printing session. When you want to set the page size to a pre-defined page size, then you must set the PageSize parameter to one of the page size values that is specified in the OIPRINT_EQUATES, and the PageWidth and PageHeight parameters must be NULL. To set the page size to a custom page size, the Get_Printer PAGESIZE message must return the 256 code. Then you can set the PageWidth and PageHeight to any custom page size. If the PageWidth and PageHeight are set, then the PageSize is ignored. For the best results you should set the PageSize parameter equal to an available page size code that was returned by the Get_Printer PAGESIZE message, and set the PageWidth and PageHeight to NULL. Always check the return code from the INIT message, because not all printers support custom page sizes. The PageHeight, PageWidth, and PageSize parameters are dependent on the current printer driver, and not all printer drivers allow custom page sizes. You should always use the most current version of the Windows printer driver. The Get_Printer PAGESIZES message returns all of the available page sizes for the current printer.
The Copies parameter is used to print multiple copies of the report. Before using the Copies parameter you should check thethe Get_Printer("SUPPORTCOPIES") message. INIT will return a -17 if your printer does not support Copies.
...
The CharMap parameter is similar to the OpenInsight bi-directional CHARMAP feature. If CharMap is not assigned or NULL, then this feature is disabled. This parameter must be a string that is 510 bytes long. The first 255 bytes are the Display values and the last 255 bytes are the Saved values. All Set_Printer messages will expect the Saved vales and will print the Display values. All Get_Printer messages will return data with the Saved values. If you wan the OIPI to use the same CHARMAP as OpenInsight, then set the OIPI CharMap field equal to Get_Property(“SYSTEM”, “CHARMAP”). The CharMap feature does not allow you to remap the TAB or CR characters.
...
The Mouse Support parameter is used to control the mouse, wheel, and keyboard navigation of the preview.
See also
Example
...
| Code Block |
|---|
/* The following example shows how to use the INIT message to print a report to the Print Preview window. The report will be printed in landscape orientation with 0.5 inch margins. The size and position of the Print Preview window will be read from the OIPI.INI file. */
declare function Set_Printer
title = "Test":@FM:@FM
title := "Cancel Button"
title := "on the %s on %s":@FM
title := "Now Printing Page %d of Report":@FM
stat = Set_Printer("INIT", "Report 1", title, "", 1, 4)
stat = Set_Printer("TEXT", "Test 1 2 3")
stat = Set_Printer("TERM") ;* End printing |
