$root.$libs.LIB.$reports.REPORT

Parent: $root.$libs.LIB.$reports
 
Children 

Instance notation

Properties Methods 

Properties

Object specific 
$aligntogridIf true,fields are snapped to the grid when they are moved
$backiconidThe 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
$backpictureThe report background picture;if $backiconid is set,$backpicture is ignored
$borderposPosition mode for page borders in reports
kBordPosLocal kBordPosMargins kBordPosPrintable
$bottommarginThe report bottom margin
$callprintonexportIf true, $print method is called when exporting data
$collectperformancedataThis property is only applied when $root.$prefs.$collectperformancedata has the value kCPDmarkedClasses.If true,method execution performance data is collected for all methods in the class
kFalse kTrue
$copiesNumber of copies to be printed
$editorThe name of the add-in tool library used to edit this class
$editordataEditor data stored with the class.Typically used by the library identified by $editor
$exportformatThe export format used by the report
kEXcommas kEXnone kEXodt kEXopl kEXtabs kEXuser
$horzdpiHorizontal dots per inch when printing the image
$horzgridThe horizontal grid size
$horzoffsetHorizontal offset for report background picture
$horzpagesIf true, the report is to print horizontal pages
$islabelIf true, the report prints as a label report
$islistIf true, the report uses data from a list
$labelcountThe number of labels across the page
$labelwidthThe width of each label
$leftmarginThe report left margin
$loadpagesetupIf true,the report instance will load the page setup data during construction
$macosdestnamemacOS printer destination file path. The pathname of the output file when $macosdesttype is kPDF or kPostScript
$macosdesttypemacOS 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
$mainfileThe name of the main file
$mainlistThe report main list
$orientationThe paper orientation
kOrientDefault kOrientLandscape kOrientPortrait
$pagesetupdataThe report page setup data
$paperThe paper type
kPa10X11 kPa10X14 kPa11X17 kPa15X11 kPa9X11 kPaA2 kPaA3 kPaA3Extra kPaA3ExtraTrans kPaA3Trans kPaA4 kPaA4Extra kPaA4Plus kPaA4Small kPaA4Trans kPaA5 kPaA5Extra kPaA5Trans kPaA6 kPaAPlus kPaB4 kPaB5 kPaB5Extra kPaB5Trans kPaBPlus kPaCSheet kPaCustom kPaDefault kPaDSheet kPaEnv10 kPaEnv11 kPaEnv12 kPaEnv14 kPaEnv9 kPaEnvB4 kPaEnvB5 kPaEnvB6 kPaEnvC3 kPaEnvC4 kPaEnvC5 kPaEnvC6 kPaEnvC65 kPaEnvDL kPaEnvInvite kPaEnvItaly kPaEnvMonarch kPaEnvPersonal kPaESheet kPaExecutive kPaFanfoldLglGer kPaFanfoldStdGer kPaFanfoldUs kPaFolio kPaIsoB4 kPaIWComputerPaper kPaIWInternationalFanfold kPaJapPostcard kPaLedger kPaNote kPaQuarto kPaStatement kPaTabloid kPaTabloidExtra kPaTSP600LongReceipt kPaTSP600Receipt kPaUsLegal kPaUsLegalExtra kPaUsLetter kPaUsLetterExtra kPaUsLetterExtraTrans kPaUsLetterPlus kPaUsLetterSmall kPaUsLetterTrans
$paperlengthThe length of the paper
$paperwidthThe width of the paper
$pathnameThe path to the class in the folder tree
$picturealignA 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 kPALcenterLeft kPALcenterRight kPALstretch kPALtile kPALtopCenter kPALtopLeft kPALtopRight
$recordspacingThe report record spacing
$repeatfactorThe report repeat factor
$rightmarginThe report right margin
$scaleThe scaling factor in percent
$showgridIf true,the window displays a dotted grid in design mode
$shownamesIf true, the report design window is to show object names instead of datanames
$sizetogridIf true,field sizes are restricted to being a multiple of the grid size
$topmarginThe report top margin
$vertdpiVertical dots per inch when printing the image
$vertoffsetVertical offset for report background picture
Standard$backcolor $backpattern $bordercolor $canremotedebugwhenlocked $classdata $classtype $componenticon $componentinfo $componenttype $createdate $desc $designtaskname $disksize $effect $external $forecolor $ident $issupercomponent $linestyle $moddate $name $parentfolder $showascheckedout $superclass $userinfo $vcsrevision $version

Methods

$clearperformancedata$clearperformancedata() Clears the performance data for all methods in the class
$findandreplace$findandreplace(cFind,cRep[,bIgnCase=kTrue,bWholeWord=kFalse,bRegExp=kFalse,bClearLog=kFalse,bReturnLog=kFalse]) If cRep is #NULL,finds all instances of cFind;otherwise,replaces all instances of cFind with cRep.Returns status row
$isa$isa(rClass|rExternalObject) Returns true if the class or instance is a subclass of the specified class or external object
$makeperformancedatalist$makeperformancedatalist() Returns a list containing the performance data collected for all methods in the class
$makesubclass$makesubclass(cName[,bAddLibPrefixForClib=kFalse]) creates a new subclass of the class,with the specified name (which can be prefixed by a library);bAddLibPrefixForClib controls whether $superclass of the new class has a library name prefix
$open$open([cInstname,params...]) starts an instance of the report;cInstName = '*' means Omnis creates instance name.Passes parameters to $construct.Returns item reference to report instance
$openonce$openonce([cInstname,params...]) starts an instance of the report,if no instance is open;cInstName = '*' means Omnis creates instance name.Passes parameters to $construct.Returns item reference to report instance
$removecodefolding$removecodefolding() Removes code folding from all methods in the class. Returns the number of methods from which code folding was removed

Children

Top 

$cvardefs$cvars$inheritedobjs$insts
$ivardefs$methods$objs$sorts