PagePreviewOptions reference

Build 1501 on 14/Nov/2017  This topic last edited on: 6/Sep/2016, at 13:33

This topic lists all valid options for the PagePreviewOptions statement as shown (in an example) in Page thumbnail options file structure.

Option

Default

Description

BoxLimit

0

Point size limit in millipoints for displaying characters as boxes. If 0 all characters are displayed normally.

Format

PNG

Preview image format, possible values are 'GIF', 'PNG' and 'JPEG'

FrameBorder

Thin

Frames border kind - possible values:

None = no frame borders

Thin = thin frame borders (1 pixel)

Thick = thick frame borders (2 pixels)

Ignored if ShowFrames is false.

FrameColor

blue

Frames border color, possible values are the standard color names 'aqua', 'black', 'blue', 'fuchsia', 'gray', 'green', 'lime', 'maroon', 'navy', 'olive', 'purple', 'red', 'silver', 'teal', 'white', 'yellow' or a red-green-blue hexadecimal color in te format '#RGB' - e.g. '#f04' -or '#RRGGBB' - e.g. '#ff0040'.

Ignored if ShowFrames is false.

FrameInfoFirst

empty

Pattern used to generate the information displayed in the first frame linked to a text.

See the help for the 'Information' tab of the Fred4 'Preferences' dialog (Edit|Preferences).

Used only if ShowInfo is true.

FrameInfoNext

empty

Pattern used to generate the information displayed in the frames linked to a text besides the first one.

See the help for the 'Information' tab of the Fred4 'Preferences' dialog (Edit|Preferences).

Used only if ShowInfo is true.

FrameOverColor

red

Overset frames border color, the possible values are the same as for FrameColor.

Ignored if ShowFrames is false.

ImageInfo

empty

Pattern used to generate the information displayed on images. Used only for dummy images (if displayed) and for non-dummy ones when ShowImages is false.

See the help for the 'Information' tab of the Fred4 'Preferences' dialog (Edit|Preferences).

InfoFontName

Arial

Name of the font used to display the information inside text frames and images.

InfoFontSize

8

Point size of the font used to display the information inside text frames and images.

JpegQuality

90

JPEG quality to use for the preview image. Used only if Format is 'JPEG'

Margin

0

Margin around the preview in millipoints

PixelWidth

1000

Width in millipoints of a pixel - i.e. the inverse of the preview resolution.

1000 corresponds to approx. 72 dpi

500 to approx. 144 dpi.

ShowBorders

false

Show frame borders and other extra information associated with frames

ShowDummy

false

Fill empty frames and image place-holders with dummy text and dummy images - to generate a preview of an empty page that shows how it will look like complete.

ShowFormat

false

Show frames' types (e.g. 'Body', 'Head' etc.). Used only if ShowBorder is true.

ShowImages

true

Show images. If false images are displayed as crossed rectangles.

ShowInfo

false

Do not display content of linked frames, but fill the text frames with the linked text workstate color and display other  information about them, as defined by FrameInfoFirst and FrameInfoNext.

ShowNonPrintable

false

Show hidden layers and page items declared 'non printable'.

Size

0

Size of the preview biggest dimension in pixel - i.e. the preview will fit in a square of this size.

If 0 the preview size is computed based on the PixelWidth option.

ShowType

false

Show frames' types (e.g. 'Body', 'Head' etc.). Used only if ShowBorder is true.

SourceImgQuality

 
(since the version 2.0)

Low

SourceImgQuality accept three values: ''Low'' (load from DB the image thumbnail, low quality), ''Medium'' (load from DB the image preview, medium quality) and ''High'' (original image).

For PagePreviews with size > 400px for a good output is better select the ''Medium'' quality.