[Overview][Types][Classes][Variables][Index] | Reference for unit 'Printers' (#lcl)

# TPrinter.EndDoc

Ends printing for the current document.

## Declaration

Source position: printers.pas line 313

`public procedure TPrinter.EndDoc;`

## Description

EndDoc is a procedure used to end printing for the current document. EndDoc calls CheckPrinting to ensure that Printing contains True. An exception is raised in CheckPrinting if Printing contains False.

EndDoc calls the EndPage method to synchronize the printer Canvas (when used) and to perform any actions required for the class implementation. The EndDoc method for the Canvas is called when RawMode is False.

DoEndDoc is called using the value in Aborted as an argument, and allows any actions needed for the class implementation to be performed.

EndDoc updates values in the PrinterFlags property to reflect the current printer and document state. The values pfPrinting and pfAborted are removed from PrinterFlags.

The value in the PageNumber is reset to 0 (zero).

Use BeginDoc to start printing a document. Use Abort to abandon printing the current document.

## See also

TPrinter.Printing |  | True if the document is currently being printed.
TPrinter.PrinterFlags |  | Status flags currently enabled for the print device.
TPrinter.RawMode |  | Indicates if raw output is used for the device (as opposed to a page description language).
TPrinter.Canvas |  | The Canvas to be used for laying out the current document ready for printing.
TPrinter.PageNumber |  | Current page number in the document being printed to the device.
TPrinter.Aborted |  | True if printing of the document has been prematurely terminated by operator command.
TPrinter.Abort |  | Terminates printing of the current document (when active).
TPrinter.BeginDoc |  | Starts printing for the current document.
TPrinterFlags |  | Represents status flag values used for printer devices.