Variables with Special Meanings |
|
| @ChangeRecordId | Assigning a value to this variable changes current data record segment id. Used for defining segment based on conditional logic. Use with caution! |
| @CopyRecord | Assigning a value to this variable duplicates current data
record with new segment id. Prefered way of defining segment based on conditional logic 1) Numeric format: Value specifies a RecordID for new copy of current record. Record is copied to the end of data buffer current+1. 2) String format: String contains list of BufferID=RecordID pairs separated with commas. Default buffer number is current+1. Syntax: [bBufferID=]nRecordID[,[bBufferID=]nRecordID]... Example: "1=1011, 2=1021, 3=1031, 5=1051" |
| @ChangeDesignId | Causes drop of current design and start with new design id from the beginning of current document |
| @DesignName | Name of a design. (read-only) |
| @DocumentName | Name of a logical document. This name is stored and used in output |
| @DocumentNo | Internal document number within one data file ( starting from 1 ) ( read-only) |
| @EnclosureGnr | Returns/sets the Enclosure group number assigned to document. |
| @Error | Places the message in the log file with the "Error" keyword, and the document is flagged as rejected and not put in the output data stream. |
| @MessageBox | Creates a modal message on the screen and system waits till somebody reads it and hits ok. |
| @Message | Places the message in the log file. |
| @Warning | Places the message in the log file with the "Warning" keyword |
| @JobError | Places the message in the log file with the "Error" keyword and the processing of the whole job is terminated. |
| @FatalError | Places the message in the log file with the "Error" keyword and the processing of the whole job is terminated. Message box on the screen is created that has to be processed. |
| @FirstSheetNo | Internal document first sheet number ( number of sheets before current document + 1 ) ( starting from 1 ) ( read-only) |
| @HLColorName | This value is controlled by output converter and each change is reported to operator ( Metacode ) |
| @Input(.prop) | Information about Input processed. Available properties
are: File ( raw name as it came ), FileName (without path and extension), FileSize( in
Bytes ), Layout ( raw name ), LayoutName (without path and extension). Example: Input.FileName |
| @IsLastDocument | This value is 1 when formatting last document in current datafile, 0 otherwise |
| @OutputQueue | Returns/sets the Output Queue name assigned to document |
| @PaperGroupName | This value is controlled by output converter and each change is reported to operator ( Metacode ) |
| @Position (.x, .y) | Returns/sets absolute position of currently processed object in 14400 dpi. |
| @RecCount(.prop) | Returns number of records. Available counters are: All, Left, Group, ID. Default is Left. |
| @Dimension (.t, .l, .b, .r, .w, .h) | Returns/sets absolute size (top, left, bottom, right, width, height) of currently processed object in 14400 dpi. Implemented for Frame only. |
| Persistent Variables | Variables with name beginning as "#" will hold
their value accross document boundary. They will be reset only at datafile end. Example: #OverallTotal |