Skip to main content
Version: Current

Add Picture

Description​

The Add Picture activity inserts a picture into a Microsoft Word document at a specified bookmark or text location.

The activity updates the specified Word File in place. The same file reference can be used by subsequent Word activities.

Common Capabilities​

Process Data Support​

info

This activity supports dynamic configuration using variables from the Process Data drawer.

You can bind values from Model Data, Form Data, System Data, Enterprise Variables, and Activity Outputs.

Learn more → Using Process Data

Execution Control​

info

Controls how this activity behaves when multiple incoming execution paths converge.

Learn more → Execution Control

On Error​

info

Defines how the workflow behaves if this activity encounters a runtime error.

Learn more → On Error

Design-Time Configuration​

Display Text​

The label displayed for this activity on the workflow canvas.

Word File​

The Word document to modify.

See Word Document Configuration.

Password​

Optional password used to open a password-protected document.

Insertion Location​

Find By​

Specifies how the insertion location is identified.

Available options:

  • Bookmark
  • Text

Default: Bookmark

Position​

Specifies where the picture is inserted relative to the matched bookmark or text.

Available options:

  • Left – Insert before the matched location.
  • Right – Insert after the matched location.
  • Replace – Replace the matched content with the picture.

Default: Replace

Bookmark To Find​

The bookmark name to locate.

Available when Find By is Bookmark.

Text To Find​

The text to locate within the document.

Available when Find By is Text.

Occurrence​

Specifies which matching occurrence to use.

Available options:

  • First
  • Last
  • All

Default: All

Picture​

Select Picture By​

Specifies how the picture is provided.

Available options:

  • File
  • URL
  • Base64

Default: File

Picture File​

A file reference to the image to insert.

Required when Select Picture By is File.

Picture URL​

The public HTTP or HTTPS URL of the image to insert.

Required when Select Picture By is URL.

Picture Base64​

The image content encoded as Base64.

Both raw Base64 content and data URI formats are supported.

Required when Select Picture By is Base64.

Supported Image Formats

Common image formats such as PNG, JPG, JPEG, GIF, and BMP are supported.

Format support can vary depending on the operating system and Word rendering engine.

Picture Options​

Alt Text​

Optional alternate text applied to the inserted picture.

Width (Centimeters)​

Optional width of the inserted picture in centimeters.

Height (Centimeters)​

Optional height of the inserted picture in centimeters.

Text Search Options​

Available when Find By is Text.

Page Lookup Mode​

Specifies whether the search is limited to particular pages.

Available options:

  • All
  • Single
  • Range

Default: All

Lookup Page By​

Available when Page Lookup Mode is Single.

Specifies how the page is identified.

Available options:

  • Page Number
  • Page Index

Page Number​

The printed page number to search.

Available when:

  • Page Lookup Mode = Single
  • Lookup Page By = Page Number

Page Index​

The zero-based page index to search.

Available when:

  • Page Lookup Mode = Single
  • Lookup Page By = Page Index

From Page Index​

The starting zero-based page index.

Available when Page Lookup Mode is Range.

To Page Index​

The ending zero-based page index.

Available when Page Lookup Mode is Range.

Search In​

Available when Find By is Text.

Body​

Search within the document body.

Default: True

Search within document headers.

Default: False

Search within document footers.

Default: False

Search Options​

Available when Find By is Text.

Match Case​

Determines whether the search is case-sensitive.

Default: False

Match Whole Words Only​

Matches complete words only.

Default: False

Use Regular Expression​

Treats Text To Find as a regular expression pattern.

Default: False

Regular Expression​

The regular expression pattern used for matching text.

Available when Use Regular Expression is enabled.

Cross-Platform Considerations​

warning

Page-based search and insertion behavior can vary between Windows and Linux because page layout calculations depend on the Word rendering engine.

For the most consistent results across platforms, use bookmarks instead of page-based text searches and prefer PNG or JPG images.

Outputs​

Document Ranges​

Collection of document ranges where pictures were inserted or updated.

See DocRange.