Macro Language Reference > Macros > Window > tpboard
  
tpboard
Description
Creates and configures PTC ALD pasteboard, a pseudo-page that can appear alongside your displayed pages as a holding area for frames. Some examples of why you might want to hold frames separately from your pages are detailed below:
to move frames between pages
to create temporary frames for importing text/graphics
to see if there is any overmatter for a stream
 
Example 314. Create a pasteboard
The macro shown below sets up a pasteboard to the right of the document, allowing it 20 per cent of the work area when wfi is used.
tpboard 0,"pboard2",20
This will create a pasteboard called pboard2 with a default size of 500mm x 500mm. If you want to change the size of the pasteboard you have to select it once it has been created and then change its size using the tpsize macro, as follows:
tpgoto "pboard2":tpsize
Syntax
tpboard board_name:t? position:n? percent_fit:n?
tpboard
[no parameter]
Invoke the Pasteboard dialog box.
board_name
The name of the pasteboard. If board_name does not already exist then it will be created. Other options for this parameter are:
Create a new pasteboard with a default name by specifying board_name as "_".
Remove a pasteboard by specifying board_name as ""
position
Where the pasteboard should be positioned on the screen:
0
On right of screen (default)
1
At bottom of screen
percent_fit
The percentage of the pasteboard to be displayed when calculating window fit with wfi.
 
Large values leave less space for the display of your document.
Additional Information
A document can contain any number of named pasteboards, although only one can be displayed at a time. Pasteboards work in a very similar way to named page styles created with tplay and are, like overlays and underlays, selected using the tpgoto macro.
 
The formatting and scroll to page operations may be slowed as the quantity and complexity of the data stored on the displayed pasteboard increases, for example large tables.
* 
You can use this macro to specify a set of default attributes for each frame drawn for a document. To do this, create a pasteboard called _fdef_tfmk using the tpboard macro, then draw a frame on this pasteboard with the required attributes, e.g. background colour, frame rules. Subsequent frames drawn on the page will have the same attributes.
You can also use this macro to specify a set of default attributes for each footnote frame drawn for a document. To do this, create a pasteboard called either _fdef_tfsurround (for properties for the footnote wrapper frame) or _fdef_tfnote (properties for individual footnote frames) using the tpboard macro, then draw a frame on this pasteboard with the required attributes as described above. The attributes will be passed to any subsequent footnote frames drawn on the page.
Related Links