$root.$ireports.REPORT

Parent: $root.$ireports
Class notation

Properties

Object specific
$appendfile If true, and printing to file, the file is appended instead of being replaced
$autoeject If true, pages are ejected automatically
$backiconid The icon identifier of the report background image. If set, must refer to either an icon set icon or an icon in a page with alpha support. If set, it takes precedence over $backpicture
$backpicture The report background picture; if $backiconid is set, $backpicture is ignored
$borderpos Position mode for page borders in reports
kBordPosLocal kBordPosMargins kBordPosPrintable
$bottommargin The report bottom margin
$callprintonexport If true, $print method is called when exporting data
$cdevice The current report destination
$charsperinch Number of characters per inch when printing to a text device
$charsperline Characters per line when printing to text device and $restrictpagewidth is true
$copies Number of copies to be printed
$cposition The current printing position for the next object of the current section
$csection The section currently being printed
$editionfile The edition file name for printing reports to publisher
$exportformat The export format used by the report
kEXcommas kEXnone kEXodt kEXopl kEXtabs kEXuser
$generatepages If true, and printing to text device, pages are generated
$hideuntilcomplete If true, screen/preview report window is hidden until report is complete
$horzdpi Horizontal dots per inch when printing the image
$horzoffset Horizontal offset for report background picture
$horzpages If true, the report is to print horizontal pages
$islabel If true, the report prints as a label report
$istext If true, the report output will be text based
$labelcount The number of labels across the page
$labelwidth The width of each label
$lastpage The last page which has been started
$leftmargin The report left margin
$linesperinch Lines per inch when printing to a text device
$linesperpage Number of lines per page when printing to text device and $generatepages is true
$loadpagesetup If true, the report instance will load the page setup data during construction
$orientation The paper orientation
kOrientDefault kOrientLandscape kOrientPortrait
$osxdestname MacOS printer destination file path. The pathname of the output file when $osxdesttype is kPDF or kPostScript
$osxdesttype MacOS printer destination. A constant: kPrinter, kPDF or kPostScript. If the report destination is printer, and the job setup dialog is not opened, the constant specifies the actual destination. For file destinations, $macosdestname is the path
kPDF kPostScript kPrinter
$pagecount The current page count
$pageheight The height of the printing area on a page
$pages The pages to be printed (empty=all)
$pagesetupdata The report page setup data
$pagewidth The width of the printing area on a page
$paper The paper type; a kPa… constant (See paper size constants)
$paperlength The length of the paper
$paperwidth The width of the paper
$picturealign A kPAL... constant which, together with $horzscroll and $vertscroll (and $autoscroll for the JavaScript client),identifies where the picture will be positioned in the field
kPALbottomCenter kPALbottomLeft kPALbottomRight kPALcenter kPALcenterLeftkPALcenterRight kPALtopCenter kPALtopLeft kPALtopRight
$portdatabits The port data bits (7 or 8)
kPort7DataBits kPort8DataBits
$porthandshake The port handshake (none, xon/xoff, hardware)
kPortHardware kPortNoHandshake kPortXonXoff
$portname The name of the port
$portparity The port parity (none, odd, even)
kPortEvenParity kPortNoParity kPortOddParity
$portprofile The name of the Port Profile that is to be used
$portspeed The port baud rate
$portstopbits The port stop bits (1 or 2)
kPort1StopBit kPort2StopBits
$printfield The field currently being printed
$printfile The print file name for printing reports to a file
$reccount The number of record sections printed for the report (#R)
$recordspacing The report record spacing
$repeatfactor The report repeat factor
$reportdataname The variable to receive report data when printing to memory
$reportfield The hwnd to which to send the screen or preview report
$reportfile The report file name for saving reports to disk. If the report destination is the Omnis PDF device then this is the path of the output PDF; when empty the PDF device will prompt the user for the path if it is not running in a server thread
$restrictpagewidth If true, and printing to text device, page width is restricted
$rightmargin The report right margin
$scale The scaling factor in percent
$sendformfeed If true, and $generatepages is true, form feeds are sent to the device
$subvariable The subtotal variable for the current subtotals section
$topmargin The report top margin
$vertdpi Vertical dots per inch when printing the image
$vertoffset Vertical offset for report background picture
$waitforuser If true, method execution is halted until screen/preview report is closed
$windowprefs Position for screen and preview windows (Title/left/top/width/height/STK/CEN)
Standard $backcolor $backpattern $bordercolor $classtype $effect $forecolor $isprivate $linestyle $name

Methods

Object specific
$accumulate $accumulate([iSection]) accumulates totals for the report
$checkbreak $checkbreak() checks if a subtotal break is required

This compares the current field values with those when it was last called; returns a constant:kSubtotal1 to kSubtotal9 or kNone if no subtotal break is required.
$ejectpage $ejectpage(iNumber) ejects a report page

This is sent to a report instance just before a page is ejected. You cannot add to a page once it is ejected; the default handler ejects the page; pages are ejected in order so ejecting a page also ejects all earlier pages. Calling $ejectpage(page number) will start and end all pages before they are ejected. $ejectpage() without a parameter ejects all pages which have been ended and not ejected.
$endpage $endpage(iNumber) ends a report page

This is sent to a report instance just before a page is ended (the next page is to be started or the page is about to be ejected). The default handler adds the footer section to the page. Calls to $endpage() for a large number of pages will result in large memory use. $endpage() without a parameter ends all pages which have been started.
$endprint $endprint() print the totals and complete the report

This is sent to a report instance by the End print command and in other circumstances when the report is terminated. The default handler prints the final subtotals and totals section and ejects all the remaining pages.
$openjobsetup $openjobsetup([bAlways]) opens the job setup dialog when printing to printer or any destination if bAlways is true

Can be called immediately after $open() for a report; if it returns kFalse (the user has cancelled), the report instance should be closed without printing any data.
$printrecord $printrecord() print a record section

This is sent to the report instance by the Print record command. The default handler prints the record section.
$printsection $printsection(iSection|rPosnSection [,bPosnIsRecord=kFalse]) prints a section.bPosnIsRecord is for positioning sections only. If bPosnIsRecord is kFalse,prints section based on position of previous section; otherwise, prints section as a record

This is sent when a section is printed; iSection is one of the constants (kRecord, kTotals, etc.) or a reference to a section field on the report instance. The default handler prints the section positioned according to $sectionstart, $sectionend and the positioning mode for the section. For a subtotal or total section the current field values are temporarily reset to those which were current when $printsection for a detail section was previously called.
$printtotals $printotals(iSection) prints a subtotal or total section

This is sent to the report instance when a subtotal break has been triggered or the report is about to be terminated; section is the highest level subtotal to be printed (a constant such as kSubtotal5or kTotals), if section is not a subtotal or totals section only the subtotal header sections are printed. The default handler prints the correct subtotal sections followed by the corresponding subtotal header sections.
$skipsection $skipsection() causes any further processing of the current section to be skipped

If you call this during $print() for a field, no further fields will be printed for that section, so positioning sections count as new sections and are not skipped if the previous section was skipped.
$startpage $startpage(iNumber) starts a report page

This is sent to a report instance when another page is started. The default handler adds the page header section to the page: for the first page, the default handler also adds the report header section to the page. Calls to $startpage for a large number of pages will result in large memory use. Starting a page always ends the previous page (only one page is started and not ended).
Standard $canclose $close

Children

$ivars $methods $objs $sorts
$tvars