optlist

Modified on Mon, Nov 20, 2023 at 3:51 PM

OPTLIST command

 

optlist is an option list specifying text Block filling options. It is used to execute commands on the surrounding block, like changing its background color or changing its location on the page. Most actions can be executed using the paragraph but they affect the text only. Optlist is used to change properties the block itself.

 

Keywords that can be used with optlist are: 

rect (Rectangle) The coordinates of the Block in the coordinate system of the Block PDF. The Block rectangle can be specified with the refpoint and boxsize options (in user coordinates). Inches and not PDF points.

IMPORTANT: If the PDF document has been cropped then the values of rect are affected, the numbers must be rectified, or the cropped area removed completely.

status (Keyword) Describes how the Block will be processed (default: active):

active The Block will be fully processed according to its properties.

ignore The Block will be ignored.

Ignoredefault Like active, except that the defaulttext/image/pdf properties will be ignored, i.e. the Block remains empty if no default contents have been provided. This may be useful to make sure that the Block’s default contents will not be used for filling Blocks on the server side although the Block may contain default contents for the Preview in the Block Plugin. It can also be used to disable the default contents for previewing a Block without removing it from the Block properties.

static No variable contents will be placed; instead, the Block’s default text, image, or PDF contents will be used if available.

backgroundcolor (Color) Fill color for the Block; this color will be applied before filling the Block. This may be useful to hide existing page contents. Default: none

bordercolor (Color) Border color for the Block; this color will be applied before filling the Block. Default: none 

linewidth (Float; must be greater than 0) Stroke width of the line used to draw the Block rectangle; only used if bordercolor is set. Default: 1

 

Make sure to leave a space between the commands.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article