ArborX


event

Longname: event   Open the Documentation Legend
Released: 7.67a 
Created: 7.67a 
See also: <?page> <?frame> clear default width height kill add-to-page raw position size text text-margins page-kill pageoffset end-of pb (n/a) after-page text-flags ttmapret ttmaprety ttignmsp ttignssp ttignesp ttignsp resize update ttmaptab (n/a) select setcols

Summary
Specifies an 'event' that is to occur as a condition of another action taking place as part of an inline frame creation command sequence within the <?frame> command. An event which triggers a frame to become active is either a number of pages being formatted from where the command was, or another frame becoming inactive i.e pagelife has become 0 or the frame was killed.
Example extract

This sample when placed inline and formatted will create a frame of 80 x 30mm at 50mm down 70mm accross with the frame name "Simple_1".

 <?frame clear> 1
 <?frame size 80mm, 30mm> 2
 <?frame position 50mm, 70mm> 3
 <?frame raw name "Simple_1"> 4
 <?frame event end-of "simple"> 5
 <?frame event end-of "simple_2"> 6
 <?frame add-to-page> 7
4
Always clear any preexisting frame properties that may be in memory, otherwise they could get applied to the frame that you are creating.
6
The size of your frame.
8
The position of your frame.
10
Give the frame a name. This is because frames are always referred to by name if they require modification (the frame number is never used). This is also useful because of the way auto frames are handled internally - the name is required to uniquely identify a frame. This is particularly important for the autocopy feature, and for killing frames.
12
This frame will become active and therefore included in the autocopy when the frame "simple_2" is no longer active.
14
Always add to page (this actually adds the frame to the page).

Syntax (7.67a)
event  end-of:n?
event  after-page:n?
where
<event_keyword> ::=  end-of:n?  |   after-page:n?
end-of:n If an auto frame is dependant on another auto frame finishing i.e. frame B is to start when frame A is finished, the ’event’ verb takes the event end-of and the name of the frame which causes that event.
after-page:n

A frame can be defined on one page and output a specified a number of pages later.

e.g <?frame event after-page 2> The frame will be created 2 pages later i.e if it is defined on page 1 it will be created on page 3.

An auto frame can be created depending on some condition or ’event’ occurring. Two such ’events’are defined. An auto frame can be dependant on another i.e. frame B is to start when frame A is finished, therefore frame A’s finishing is regarded as an ’event’ which will trigger frame B. And an auto frame can be defined on one page to start x pages later.

See also Technote 0063; Auto Copy and Frame Page Life; 7.68a.


Document created on 07-Apr-2003 (revision 001)