Show TOC

Function documentationPDF Image

 

This action is used to add an image to an Adobe® portable document format (PDF) document.

Features

The properties for this action are listed in the following table:

Property

Data Type

Access

Use

Source Document

String

In and out

The PDF document to which you want to add an image.

Caption

String

In and out

A title for the image.

Font Name

String

In and out

The font of the caption.

The following fonts are available:

  • Helvetica

  • Courier

  • Times New Roman

Font Style

Integer

In and out

The style of the caption text.

The following styles are available:

  • 0 (normal)

  • 1 (bold)

  • 2 (italic)

  • 3 (bold italic)

  • 4 (underline)

Font Size

Integer

In and out

The size of the caption text.

Alignment

Integer

In and out

The position of the caption text.

The following positions are available:

  • 0 (left)

  • 1 (center)

  • 2 (right)

  • 3 (justified)

Text Color

String

In and out

The color of the caption text.

The following values are available:

  • Hexadecimal (for example, #F8F8F8)

  • RGB (for example, 255,255,255)

  • HTML (for example, orange)

Background Color

String

In and out

The color of the background text of the caption.

You can use the same values as in the Text Color.

Spacing Before

Integer

In and out

Amount of white space, in points, between the image and the previous section. (72 points equals one inch.)

Spacing After

Integer

In and out

Amount of white space, in points, between the image and the following section. (72 points equals one inch.)

Encoded Image

String

In and out

The image you want to add to the PDF document.

To get the image string, use the Image Loader action. You can link the EncodedImage output of the Image Loader action to the EncodedImage input of the PDF Image action.

Output

XML

In and out

The XML output.

Success

Boolean

Out

Indicates whether the action succeeded or failed.