ArborX


add-to-page

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

Summary
Will add the defined frame to the specified page as part of an inline frame creation command sequence and must always end the sequence within the <?frame> command.
Example extract

This sample when placed inline and formatted will create a frame of 80 x 30mm positioned 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 add-to-page> 5
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
Always add to page (this actually adds the frame to the page).

Syntax (7.67a)
add-to-page Ø
add-to-page  number_of_frames:n?
number_of_frames:n Add the frame to a page. The paremeter refers for the number of frames to be created, not the pages. You must also ensure that the positioning statement is correct if you do not want the frames on top of each other.

If a frame cannot be added, an error will be output in the format log.

The frame verbs can be used in any order, although <?frame clear> must always start a new frame and <?frame add-to-page> must be at the end. If <?frame raw frame ....> is used, this must come directly after <?frame clear> as it also performs initialisation.

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