Sign in Join
FPDoc Onlineexperiment

TPrinter.CheckRawMode procedure

Member of TPrinterprotectedIn unit Printers

Ensures that RawMode contains the specified value.

Declaration

pascal
procedure CheckRawMode(const Value: Boolean; Msg: string='')

Arguments

Value

Value required in the RawMode property.

Msg

Message text for an exception raised in the method.

Description

CheckRawMode is a procedure used to ensure that the RawMode property contains the specified Value. If RawMode does not have the requested value, an EPrinter exception is raised. Msg contains the message text for the exception. When Msg is not specified, or contains an empty string ( ''), a default message is used:

Value is True
Msg contains 'Printer is in Raw Mode'
Value is False
Msg contains 'Printer is not in Raw Mode'

CheckRawMode is called when getting the value for the Canvas property.

Errors

Raises an EPrinter exception when RawMode does not contain the required value.

See also

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