ArborX

end-of

Longname: end-of   Open the Documentation Legend
Released: 7.67a 
Created: 7.67a 
See also: event <?frame>

Summary
 Two 'events' are defined for autoframes - 'end-of' and 'after-page'. The 'end-of' event occurs when an autoframe is no longer created i.e. its pagelife has been decremented to 0, or the frame has been 'killed'. This event can be used to trigger another frame (which already exists, but has not been placed on a page) to became active and included in page/frame creation by the autocopy.
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". This frame will start when frame "simple" is no longer active.

 <?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 add-to-page> 6
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 start when frame "simple" is no longer active i.e its pagelife is 0, or it is 'killed'.
14
Always add to page (this actually adds the frame to the page).

Syntax (7.67a)
end-of Ø
end-of  frame_name:n?
frame_name:n The name of the frame at the end of which should initiate the event trigger. When the frame "frame_name" is finished (i.e no longer created by the autocopy), this 'event' will trigger the new frame to become active.

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.

The keyword pageoffset follows the frame name and is the number of pages on from where the ’event’ occurs, where the new frame will start. By default, a frame will start on the same page, which is the same as specifying pageoffset 0, or omitting it altogether.

e.g >?frame event end-of "A" pageoffset 2<

Frame A would typically finish because of a <?frame kill "fname"> command or its pagelife coming to an end. See tfpagelife and Technote 0063; Auto Copy and Frame Page Life; 7.68a.

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