Print according to specified options. If no print-time commands are used prior to this command, the document will be printed according to the current default settings. If the Action parameter is left blank, the document will be printed using the current print action.
Specify the pages to print. Follow this command with Print(AdvancedMultiplePages!).
The following rules apply to all PrintAdvancedRangeData parameter specifications:
¿ To specify all Pages, Secondary Pages, Chapters, or Volumes use ("all").
¿ Use the same numbering method as the document uses. For example, if the current Page number method is (A,B,C,...) and you want to print the first three pages, use ("A-C") in the Pages parameter, not ("1-3").
¿ If you do not wish to specify a range or value for a parameter, use a null string ("").
Parameters
Pages: string The pages to print.
SecondaryPages: string The secondary pages to print.
Chapters: string The chapters to print.
Volumes: string The volumes to print.
numeric:=PrintBooklet
Syntax
(State: enumeration)
Description
Turn booklet printing on or off.
Return Value
If the State parameter is omitted, its current value is returned. If the State parameter is included, the current value is returned, then the new value is set.
0 Booklet printing is off.
1 Booklet printing is on.
Parameters
State: enumeration (optional) False!
True!
numeric:=PrintCopies
Syntax
(NumberOfCopies: numeric)
Description
Specify the number of copies to print.
Return Value
Returns the number of copies to print. If the NumberOfCopies parameter is omitted, its current value is returned. If the NumberOfCopies parameter is included, the current value is returned, then the new value is set.
Parameters
NumberOfCopies: numeric The number of copies of each page to print.
any:=PrintDestination
Syntax
(Destination: any)
Description
Specify to print to a printer, file, or printer port.
Return Value
Returns the filename string, printer name string, 0 (if DriverPort! was selected), or 1 (if PromptForFilename! was selected). If the Destination parameter is omitted, its current value is returned. If the Destination parameter is included, the current value is returned, then the new value is set.
Parameters
Destination: any (optional) Use a string specifying a path and filename to print to a file. Use a string specifying the name of a printer to print to a specific printer. Use PromptForFilename! to prompt the user for a filename to print to. Use DriverPort! to print to the current printer port.
DriverPort!
PromptForFilename!
PrintDlg
Syntax
()
Description
Display the Print dialog box.
PrinterCommand
Syntax
(Flag: enumeration; Command: string)
Description
Insert a [Ptr Cmnd] code at the insertion point.
Parameters
Flag: enumeration Specify whether the Command parameter contains a printer command or filename.
Command!
File!
Command: string The printer command or name of a file that contains one or more printer commands.
PrinterCommandDlg
Syntax
()
Description
Display the Printer Command dialog box.
PrinterPause
Syntax
()
Description
Insert a [Pause Ptr] code at the insertion point to pause the current print job.
string:=PrinterSelectByName
Syntax
(PrinterName: any)
Description
Specify a printer to print to.
Return Value
Returns the printer name string, or 0, if Default! was selected. If the PrinterName parameter is omitted, its current value is returned. If the PrinterName parameter is included, the current value is returned, then the new value is set.
Parameters
PrinterName: any (optional) The name of the printer to print to. For a list of valid names for the current computer, see the Name drop-down list in the Printer dialog tab of the Print dialog box. This list will probably vary from one computer to another.
Default!
PrinterSelectDlg
Syntax
()
Description
Display the Print to dialog box with the Printer tab selected.
boolean:=PrintGraphically
Syntax
(State: enumeration)
Description
Turn the Print graphically option on or off.
Return Value
Returns True if the Print graphically option is on, False if not. If the State parameter is omitted, its current value is returned. If the State parameter is included, the current value is returned, then the new value is set.
Parameters
State: enumeration (optional) False!
True!
boolean:=PrintGraphics
Syntax
(State: enumeration)
Description
Turn graphics printing on or off.
Return Value
Returns True if graphics printing is on, False if not. If the State parameter is omitted, its current value is returned. If the State parameter is included, the current value is returned, then the new value is set.
Parameters
State: enumeration (optional) False!
True!
PrintHistoryDlg
Syntax
()
Description
Display the Print Status and History dialog box.
numeric:=PrintImageBinding
Syntax
(Edge: enumeration)
Description
Specify the binding edge. Use this command with PrintImageOffset and PrintTwoSided. This is a print-time option and does not insert a code in the document.
Return Value
If the Edge parameter is omitted, its current value is returned. If the Edge parameter is included, the current value is returned, then the new value is set.
0 Left edge
1 Right edge
2 Top edge
3 Bottom edge
4 Inside edge
5 Outside edge
Parameters
Edge: enumeration (optional) BottomEdge!
InsideEdge!
LeftEdge!
OutsideEdge!
RightEdge!
TopEdge!
measurement:=PrintImageOffset
Syntax
(Offset: measurement)
Description
Specify the binding edge offset. Use this command with PrintImageBinding. This is a print-time option and does not insert a code in the document.
Return Value
Returns the current printing offset value in WordPerfect Units (1/1200 in). If the Offset parameter is omitted, its current value is returned. If the Offset parameter is included, the current value is returned, then the new value is set.
Parameters
Offset: measurement (optional) The distance to shift a page image. WordPerfect Units (1/1200 in) are assumed unless the DefaultUnits command precedes this command, or the units of the parameter are specified. To specify units for this parameter, include a unit indicator following the value. For example, PrintImageOffset(Offset: 1") specifies the value 1 as inches.
boolean:=PrintInColor
Syntax
(State: enumeration)
Description
Turn color printing on or off. This is a print-time option and does not insert a code in the document. PrintInColor takes effect only when the current printer is capable of color printing, regardless of the value returned.
Return Value
Returns True if Print in color is on, False if not. If the State parameter is omitted, its current value is returned. If the State parameter is included, the current value is returned, then the new value is set.
Parameters
State: enumeration (optional) False!
True!
boolean:=PrintInReverseOrder
Syntax
(State: enumeration)
Description
Turn reverse order printing on or off. This is a print-time option and does not insert a code in the document.
Return Value
Returns True if reverse order printing is on, False if not. If the State parameter is omitted, its current value is returned. If the State parameter is included, the current value is returned, then the new value is set.
Parameters
State: enumeration (optional) False!
True!
numeric:=PrintRangeFrom
Syntax
(Page: numeric)
Description
Specify the first page in the print range. This is a print-time option and does not insert a code in the document. Use this command with PrintRangeTo and Print(Action: MultiplePages!).
Return Value
Returns the first page in the current print range. If the Page parameter is omitted, its current value is returned. If the Page parameter is included, the current value is returned, then the new value is set.
Parameters
Page: numeric (optional) The first page to print.
numeric:=PrintRangeTo
Syntax
(Page: numeric)
Description
Specify the last page in the print range. This is a print-time option and does not insert a code in the document. Use this command with PrintRangeFrom and Print(Action: MultiplePages!).
Return Value
Returns the last page in the current print range. If the Page parameter is omitted, its current value is returned. If the Page parameter is included, the current value is returned, then the new value is set.
Parameters
Page: numeric (optional) If this parameter equals zero, print to the end of the document.
numeric:=PrintResolution
Syntax
(Quality: enumeration)
Description
Specify the print resolution (quality).
Return Value
If the Quality parameter is omitted, its current value is returned. If the Quality parameter is included, the current value is returned, then the new value is set.
1 Low
2 Medium
3 High
Parameters
Quality: enumeration (optional) The print quality. Some printers allow more levels of print quality. To specify print quality on those printers, use 0-10. Refer to the specific printer documentation for print quality levels.
High!
Low!
Medium!
numeric:=PrintResolutionDpiX
Syntax
(DPI: numeric)
Description
Specify the horizontal dots per inch (DPI) for a print job. The direction is relative to the printer, not the page. Always use this command together with PrintResolutionDPIY. PrintResolutionDPIX and PrintResolutionDPIY will always override the PrintResolution command unless the value specified in the DPI parameter is not valid for the printer used. See your printer documentation for valid DPI values.
Return Value
Returns the horizontal dots per inch. If the DPI parameter is omitted, its current value is returned. If the DPI parameter is included, the current value is returned, then the new value is set.
Parameters
DPI: numeric (optional) The horizontal print resolution.
numeric:=PrintResolutionDpiY
Syntax
(DPI: numeric)
Description
Specify the vertical dots per inch (DPI) for a print job. The direction is relative to the printer, not the page. Always use this command together with PrintResolutionDPIX. PrintResolutionDPIX and PrintResolutionDPIY will always override the PrintResolution command unless the value specified in the DPI parameter is not valid for the printer used. See your printer documentation for valid DPI values.
Return Value
Returns the vertical dots per inch. If the DPI parameter is omitted, its current value is returned. If the DPI parameter is included, the current value is returned, then the new value is set.
Parameters
DPI: numeric (optional) The vertical print resolution.
PrintSettings
Syntax
(Action: enumeration; SettingName: any)
Description
Add, delete, update, and use printer named settings. Use other print option commands to set current options. Then use this command to save those options as a named setting.
Parameters
Action: enumeration Add!
Delete!
Update!
Use!
SettingName: any (optional) The name of the driver Named Setting. To apply the action specified in the Action parameter to the default setting, use Default!.
Default!
DriverSettings!
numeric:=PrintSortOrder
Syntax
(Order: enumeration)
Description
Specify how to sort the pages of multiple-copy print jobs.
Return Value
Returns the current sorting for multiple-copy print jobs. If the Order parameter is omitted, its current value is returned. If the Order parameter is included, the current value is returned, then the new value is set.
Parameters
Order: enumeration (optional) Collate!
Group!
string:=PrintSourceFileName
Syntax
(Filename: string)
Description
Specify a document on disk to print.
Return Value
Returns the current filename to print from. If the PrinterName parameter is omitted, its current value is returned. If the PrinterName parameter is included, the current value is returned, then the new value is set.
Parameters
Filename: string (optional) The filename of the document you want to print.
Print a specified file on disk to a specified printer.
Parameters
Filename: string The path and filename of the file to print.
PrinterName: string The name of the printer to print to. For a list of valid names for the current computer, see the Name drop-down list in the Printer dialog tab of the Print dialog box. This list will probably vary from one computer to another.
PrinterDevice: string Not used.
PrinterPort: string Not used.
numeric:=PrintTwoSided
Syntax
(Option: enumeration)
Description
Turn two-sided printing on or off and specify options. Use PrintTwoSided with PrintUseTwoSidedDocCodes(State: False!) to ensure predictable results. This is a print-time option and does not insert a code in the document.
Return Value
If the Option parameter is omitted, its current value is returned. If the Option parameter is included, the current value is returned, then the new value is set.
0 None
1 Use Long edge for binding
3 Use Short edge for binding
4 Odd pages only
5 Even pages only
Parameters
Option: enumeration (optional) EvenOnly!
LongEdge!
None!
OddOnly!
ShortEdge!
PrintTwoSidedDocCodesDlg
Syntax
()
Description
Display the Two-Sided Document Settings dialog box.
boolean:=PrintUseTwoSidedDocCodes
Syntax
(State: enumeration)
Description
Turn Use two-sided document settings on or off.
Return Value
Returns True if Use two-sided document settings is on, False if not. If the State parameter is omitted, its current value is returned. If the State parameter is included, the current value is returned, then the new value is set.
Parameters
State: enumeration (optional) False!
True!
boolean:=PrintWithDocumentSummary
Syntax
(State: enumeration)
Description
Turn document summary printing on or off.
Return Value
Returns True if document summary printing is on, False if not. If the State parameter is omitted, its current value is returned. If the State parameter is included, the current value is returned, then the new value is set.
Parameters
State: enumeration (optional) False!
True!
ProofReadAsYouGoOff
Syntax
()
Description
Turn off Spell-As-You-Go and Grammar-As-You-Go.
ProofReadGrammar
Syntax
()
Description
Mark and correct grammar errors as you type.
PublishToBaristaDlg
Syntax
(FileName: string)
Description
Display the Publish to Barista dialog box and specify a filename.
Parameters
FileName: string The filename of the document to print to Barista.
PublishToEnvoyDlg
Syntax
()
Description
Publish the current document to the Envoy viewer and display it in Envoy.
PublishToFaxDlg
Syntax
([FileName: string])
Description
Fax a document.
Parameter
FileName: string (optional) The name of the file you want to fax.
