CIB pdf toolbox 2 technical documentation

4. Usecases

4.5. Rendering PDF documents

You can render a PDF document to one or more image types at the same time.

Property

Meaning

Type

Render

“1” activates rendering of the document.

Set

Render.ImageType

A ;-separated list of image output types. Currently Bmp, Jpg,
Png and Tiff are supported.

Set

Render.ImageScaling

Setting an image dpi for rendering. Default is 150dpi.

Set

JpegQuality

Sets the jpeg quality, if images are saved as Jpeg or Jpeg2000

Default is 80

Set

PngCompressLevel

Setting the PNG compression level (1-10) for png images

Set

Render.Bounds

Setting bounds of which part of the page should be rendered.
Bounds is a tuple of 4 numbers, separated by a semicolon. It is
X;Y;width;height.
The numbers can be set in point, mm or cm, depending on the
suffix (pt, cm and mm).
The anchor of the coordinates is top left. By default the whole
page is rendered and this can be kept unset.

Set

Render.DPIAware

Render.DPIAware=0 : No dpi information is written into the
images. (Default)
Render.DPIAware=1 : Use internal calculated dpi for the
images
Render.DPIAware=150 : Predefine DPI from outside. Using in
this case 150.

Set

Render.MaxSize

Setting a MaxWidth and MaxHeight in pixel, where the
rendered image should not exceed.
Example: “100;100” => No image with with or height larger
than 100 px is rendered. Independent from the DPI set from
ImageScaling.
Default is “0;0”, which disables this check

Set

RenderOutputFilenamePattern

Defining a pattern for the output filesnames. This is a sprintf type pattern, which should include a placeholder for a number of the page rendered and optionally for a string, which will be replaced by the original filename.

Set

Render.OutputType

Set “memory” or “file”, if you want to have the output saved to
memory or file. "file” is default.

Set

RenderPageSelection

Defining a page selection, which pages should be rendered.

Set

Render.Formfields

Defines, if the content of formfields should be rendered or not.
Default is 1.

Set

Render.AllowFontFall
back

Defines, if the content of text should be rendered or not,
which can be rendered only by a fallback font, because the
original font is not available.

Default is 1.

Set

Render.Annotations

Defines, if the content of annotations (other than formfields)
should be rendered or not.

Default is 1.

Set

Render.Signatures

Defines, if the content of signatures should be rendered or
not. Default is 1.

Set

Render.TiffSinglePage

Defines, if tiff images should be generated as single-page
images.
Default is 0, so that multi-page tiff is generated by default

Set

Render.TextRenderM
ode

By this you can configure, which classes of text is rendered. By
default all text is rendered.
RenderSymbolic: Only symbolic text is rendere
RenderNonSearchable: Only non-searchable text is rendered
RenderNoText: No digital text is rendered

Set