Sign in Join
FPDoc Onlineexperiment

TPrinter.EndDoc procedure

Member of TPrinterpublicIn unit Printers

Ends printing for the current document.

Declaration

pascal
procedure 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

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.