Elementname: PlaceObject

Description

Outputs a rectangular object (image, table, box or textblock).

Allowed attributes: allocate, area, background, backgroundcolor, column, frame, framecolor, groupname, hreference, keepposition, maxheight, page, row, rulewidth, valign, vreference

Child elements: Barcode, Box, Image, Rule, Table, Textblock

Parent elements: AtPageCreation, AtPageShipout, Case, Contents, ForAll, Loop, Otherwise, Record, SavePages, Until, While

Attributes

allocate (yes/no, optional)

Determines if the area of the object is marked as »allocated«. With allocate="no", the cursor position is not changed.

area (string, optional)

Name of the (positioning) area, the ojbect is placed in. If no area is given, the object is placed on the main area, the page (this is the area that contains all grid cells).

background (full, without, optional)

Fill the background of the object (full grid cells) with a color, given by backgroundcolor.

backgroundcolor (string, optional)

Color of the background if ›background‹ is set to ›full‹.

column (number or length, optional)

If contents is a number: the grid cell from the left margin of the area. If it is a length: the absolute position from the left paper margin. If this attribute is omitted, the system tries to place the object by itself.

frame ('solid' or 'without', optional)

Draw a solid frame around the object.

framecolor (string, optional)

The color of the frame around the object. Only makes sense in combination with the attribute 'frame'.

groupname (string, optional)

The name of the group that gets output. When given a groupname, PlaceObject should not contain any objects.

hreference (optional)

Determines the placement of the object relative to the given column. If 'left' (which is the default), the given column is the left border of the object. If 'right', the column determines the right edge of the object.

left:

The object is placed in given column.

right:

The given columns determines the right edge of the border.

keepposition (yes/no, optional)

Don't move the virtual cursor to the next free space

maxheight (number, optional)

Only used for multi-page table: the maximum height of tables.

page (number, optional)

The page (later in the PDF), the object should appear on. Number of the keyword »next« for the next page.

row (number or length, optional)

The row where the object is placed. If none given, the publisher tries to find a row by itself. You can give a number (in grid cells) or an absolute value (from top left).

rulewidth (Length (mm,in,cm,pt), optional)

The thickness of the frame that is drawn around the object. Only makes sense in combination with the attribute 'frame'.

valign (optional)

When an object is placed on the grid and it's height is not a multiple of grid height, there is a space left on the page between the object an the next grid cell. With this attribute you can instruct the software where to place the gap.

top:

The object is aligned at the top.

middle:

The object is aligned so that the space at the top is the same as at the bottom.

bottom:

The object is aligned at the bottom.

vreference (optional)

Sets the placement of the object relative to the given row.

bottom:

The row determines the bottom edge of the object.

top:

If 'top' (default), the given row is the top border of the object.

Example

Positioning inside the grid:

<Record element="image">
  <PlaceObject column="12" frame="solid" framecolor="red">
    <Image width="10" file="_samplea.pdf"/>
  </PlaceObject>
</Record>

Absolute positioning (from top left edge):

<Record element="image">
  <PlaceObject column="1cm" row="4cm" frame="solid" framecolor="red">
    <Image width="10" file="_samplea.pdf"/>
  </PlaceObject>
</Record>

Info

The objects can be placed in a grid (when the value in the attributes row and column are numbers) or they can be placed with absolute positions where the origin is at the top and left border of the page.

See also

Image, Box, Tablerule, Table, Textblock, DefineColor, Output

Commands

Version: 2.0.0 | Start page | Command reference | Other languages: German