Syntax 3 For RichTextEdit controls

Description

Prints the contents of a RichTextEdit control.

Controls

RichTextEdit controls

Syntax

<span>rtename</span>.<span>Print</span> ( <span>copies</span>, <span>pagerange</span>, <span>collate</span>, <span>canceldialog</span> )

1	<span>rtename</span>.<span>Print</span> ( <span>copies</span>, <span>pagerange</span>, <span>collate</span>, <span>canceldialog</span> )

Argument	Description
rtename	The name of the RichTextEdit control whose contents you want to print.
copies	An integer specifying the number of copies you want to print.
pagerange	A string describing the pages you want to print. To print all pages, specify an empty string (“”). To specify a subset of pages, use dashes to specify a range and commas to separate ranges and individual page numbers—for example, “1-3” or “2,5,8-10”. When rtename shares data with a DataWindow, pagerange refers to pages based on the total number of pages in the control, not within each instance of the document.
collate	A boolean value indicating whether you want the copies collated. Values are: TRUE – Collate copies FALSE – Do not collate copies
canceldialog	A boolean value indicating whether you want to display a nonmodal dialog box that allows the user to cancel printing. Values are: TRUE – Display the dialog box FALSE – Do not display the dialog box

Return Values

Integer. Returns 1 if it succeeds and
-1 if an error occurs.

Usage

When the RichTextEdit control shares data with a DataWindow,
the total number of pages contained in the control is the page count
of the document multiplied by the row count of the DataWindow.

You can specify printed page numbers by including an input
field in the header or footer of your document.

Examples

This statement prints one copy of pages 1 to 5 of
the document in the RichTextEdit control rte_1.
The output is not collated and a dialog box displays to allow the
user to cancel the printing:

rte_1.<span>Print</span>(1, "1-5", FALSE, TRUE)

1	rte_1.<span>Print</span>(1, "1-5", FALSE, TRUE)

Connection Information

Syntax 3 For RichTextEdit controls – PB Docs 126