Description
Sends the contents of a DataWindow control or DataStore object to the printer as a print job.
Applies to
|
DataWindow type |
Method applies to |
|---|---|
|
PowerBuilder |
DataWindow control, DataWindowChild object, DataStore object |
Syntax
PowerBuilder
integer dwcontrol.Print ( { boolean canceldialog {, showprintdialog } } )
|
Argument |
Description |
|---|---|
|
dwcontrol |
The name of the DataWindow control, DataStore, or child DataWindow that contains the information to be printed. |
|
canceldialog (optional) |
A boolean value indicating whether you want to display a nonmodal dialog that allows the user to cancel printing. Values are:
Working with DataStore objects When working with DataStores, the canceldialog argument must always be set to false. |
|
showprintdialog (optional) |
A boolean value indicating whether you want to display the system Print dialog box. Values are: True -- Display the dialog box False -- (default) Do not display the dialog box Working with DataStore objects When working with DataStores, if "UseHwnd=no" is set under the [DataStore Behavior] section in the PB.INI file, the showprintdialog argument must always be set to false. |
Return value
Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, Print returns null.
Usage
Printed output uses the same fonts and layout that appear on screen for the DataWindow object.
When the DataWindow object's presentation style is RichTextEdit, each row begins a new page in the printed output.
PowerBuilder environment
PowerBuilder manages print jobs by opening the job, sending data, and closing the job. When you use Syntax 1, print job management happens automatically. You do not need to use the PrintOpen and PrintClose functions.
Use Syntax 1 to print the contents of a DataWindow object. The Print method prints all the rows that have been retrieved. To print several DataWindows as a single job, do not use Print. Instead, open the print job with PrintOpen, call the PowerScript system function PrintDataWindow for each DataWindow, and close the job.
Events for DataWindow printing
When you use Print for DataWindow controls or DataStores, it triggers a PrintStart event just before any data is sent to the printer (or spooler), a PrintPage event for each page break, and a PrintEnd event when printing is complete.
The PrintPage event has return codes that let you control whether the page about to be formatted is printed. You can skip the upcoming page by returning a value of 1 in the PrintPage event.
Examples
The following statements are equivalent. Each sends the contents of dw_employee to the current printer. The Cancel dialog box displays, allowing the user to cancel the printing, but the Print dialog box does not:
dw_employee.Print() dw_employee.Print(true) dw_employee.Print(true, false)
This statement sends the contents of dw_employee to the current printer. The Print dialog box displays but the Cancel dialog box does not:
dw_employee.Print(false, true)
See also
PrintDataWindow in the section called “PrintDataWindow” in PowerScript Reference
