PrintFile Members

PrintFile overview

Public Constructor


overloaded method PrintFile

This can not be called directly in code, instantiate using DCLPRINTFILE .

Public Properties


public property Collate

Gets or sets whether collation will be used when printing multiple copies.

public property Copies

Gets or sets the number of copies to print.

public property CursorY

Gets the position, in Print Units, that the printer is from the top of the page.

public property Duplex

Gets or sets whether the printer file is to print duplex (prints on both sides of the paper). This property is of type .

public property FooterSize

Gets the size of the page footer.

public property FormName

Gets or sets the name of the customized page size to use.

public property InOverflow

Gets the overflow state of the printer file. This property is of type *Boolean. When the value is True, the print file is within the overflow area, otherwise False.

public property IsOpen

Gets the open state of the printer file. This property is of type *Boolean. When the value is *True, the file is Open. (Same as the %Open built-in function.)

public property LastException

Gets the last exception thrown for this file. This property is of type ASNA.VisualRPG.Runtime.AvrException.

public property ManuscriptPath

Gets or sets the file and path name for the manuscript.

public property Orientation

Gets or sets the print orientation (Horizontal or Vertical). This property is of type ASNA.DataGate.Common.PaperOrientation.

public property PageLength

OBSOLETE: This property is marked obsolete and is referenced only for backward compatibility.  This has been replaced with PrintableLength property.

public property PageWidth

OBSOLETE: This property is marked obsolete and is referenced only for backward compatibility.  This has been replaced with PrintableWidth property.

public property PaperLength

Gets or sets the physical length of the page. Valid only with a continuous-form printer.

public property PaperSize

Gets or sets the paper size. This property is of type .

public property PaperSource

Gets or sets the printer tray that will be used. This property is of type .

public property PaperWidth

Gets or sets the physical width of the paper. Valid only with a continuous-form printer.

public property Preview

Gets or sets whether the print preview dialog is to be displayed before printing. This property is of type ASNA.DataGate.Common.AccessMode.

public property PrintableLength

Gets the length of the printer's printable area.

public property PrintableWidth

Gets the width of the printer's printable area.

public property Printer

Gets or sets the full path name of the printer to be used.

public property PrintSetup

Gets or sets whether the print setup dialog is to be displayed before printing.

public property ProcessMacro

Gets or sets whether DataGate print engine is to search for page numbering “macros” and replace them with appropriate data before sending the output to the printer.

public property Quality

Gets or sets the print quality. This property is of type .

public property ReportName

Gets or sets the name of the report as seen on the printer spool. If not assigned, the default name is the name given when the print file was declared.

public property Scale

Gets or sets the percentage factor by which the printed document is to be scaled.

public property TTOption

Gets or sets how true type fonts are to be printed. This property is of type ASNA.DataGate.Common.PrintTrueType .

public property UseColor

Gets or sets whether to print in color when a color printer is specified.

public property YResolution

Gets or sets the Y-axis resolution (in dot per inch) when printing graphics.


Public Fields


public method DclFileName

Contains the name of the file field. This field is readonly.

public field DclPrintFileName

Contains the name of the file field.

public field FilePath

Contains a string that specifies the path of the file.

public field IsFormatID

Contains True if the opened (run-time) file's format ID is equal to the declared (compile-time) file's format ID.


Protected Fields


public field isOpen

Contains the open state of the printer file.  When the value is True, the file is open.

public field lastException

Contains the last exception thrown for this file. This is a protected public field of type ASNA.VisualRPG.Runtime.AvrException.

See Also