Skip to main content
Version: Current

Find Text

Description​

The Find Text activity searches for text within a Microsoft Word document and returns information about matching occurrences.

This activity does not modify the document.

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 search.

See Word Document Selection.

Password​

Optional password used to open a password-protected document.

Text To Find​

The text to search for within the document.

Occurrence​

Specifies which matching occurrences are returned.

Available options:

  • First
  • Last
  • All

Default: All

Text Search Options​

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​

Body​

Search within the document body.

Default: True

Search within document headers.

Default: False

Search within document footers.

Default: False

If Body, Header, and Footer are all disabled, the document body is searched automatically.

Search Options​

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 the search pattern as a regular expression.

Default: False

Regular Expression​

The regular expression pattern used to identify matches.

Available when Use Regular Expression is enabled.

Cross-Platform Considerations​

warning

Page information returned by the activity is derived from document layout and can differ between Windows and Linux because page rendering is platform-dependent.

For the most consistent behavior across platforms, use content-based searches and avoid relying on page-specific results when possible.

Outputs​

Result​

A collection of matching text occurrences found within the document.

See FindResult.