Word Models
Overview
This page describes object types returned by Microsoft Word workflow activities and enums used in activity configuration.
Use these models when binding activity outputs in the Process Data drawer or when mapping results in downstream activities.
For page-related behavior across operating systems, see Cross-Platform Considerations.
FindResult
Returned by:
- Find Text (Result)
Properties
| Property | Type | Description |
|---|---|---|
| TextPosition | Int32 | Character position within the document where the text was found. This value is generally more stable across operating systems than PageIndex. |
| PageIndex | Int32 | Zero-based layout page index where the match was found. This value can differ between Windows and Linux for the same document. |
DocRange
Returned by:
- Add Picture (Document Ranges)
- Replace Picture (Document Ranges)
Properties
| Property | Type | Description |
|---|---|---|
| Start | Int32 | Start character position of the range within the document. |
| End | Int32 | End character position of the range within the document. |
HyperlinkInfo
Returned by:
- Get Hyperlinks (Hyperlinks)
Properties
| Property | Type | Description |
|---|---|---|
| Target | String | Hyperlink target. |
| NavigateUri | String | Navigation URI when applicable. |
| Anchor | String | Bookmark or anchor within the document. |
| ToolTip | String | Tooltip text associated with the hyperlink. |
| Visited | Boolean | Indicates whether the hyperlink is marked as visited. |
| Range | DocRange | Character range occupied by the hyperlink. |
| Text | String | Visible hyperlink text. |
ReplacementResult
Returned by:
- Find and Replace (Result)
Properties
| Property | Type | Description |
|---|---|---|
| BodyReplacements | Int32 | Number of replacements made in the document body. |
| ReplacedInHeader | Boolean | Indicates whether a replacement occurred in a header. |
| ReplacedInFooter | Boolean | Indicates whether a replacement occurred in a footer. |
Primitive Outputs
The following activities return standard .NET types directly.
| Activity | Output | Type | Description |
|---|---|---|---|
| Read Text | Text | String | Extracted document text. |
| Read Bookmarked Text | Text | String | Text contained within the specified bookmark range. |
| Append Text | Result | Boolean | Returns true when text is appended successfully. |
| Get Page Indexes | Page Indexes | List[Int32] | Zero-based page indexes that correspond to a printed page number. Layout-dependent. |
| Get Table | Result | DataTable | Rows and columns extracted from the bookmarked table. |
Enums
The following enums are used by Microsoft Word activity inputs. Values correspond to the options available in the Agent Builder.
PageLookupMode
Specifies whether an operation applies to all pages, a single page, or a page range.
| Value | Description |
|---|---|
| All | All pages. |
| Single | A single page. |
| Range | A range of pages identified by page index. |
LookupPageBy
Specifies how a page is identified.
| Value | Description |
|---|---|
| PageIndex | Identify the page by its zero-based layout index. |
| PageNumber | Identify the page by its printed page number. |
Occurrence
Specifies which matching occurrences should be processed.
| Value | Description |
|---|---|
| First | The first matching occurrence. |
| Last | The last matching occurrence. |
| All | All matching occurrences. |
FindBy
Specifies how content is located within the document.
| Value | Description |
|---|---|
| Bookmark | Locate content using a bookmark name. |
| Text | Locate content using text search. |
Position
Used by Add Picture when inserting a picture relative to a matched location.
| Value | Description |
|---|---|
| Left | Insert before the matched content. |
| Right | Insert after the matched content. |
| Replace | Replace the matched content. |
HyperlinkType
Used by Insert Hyperlink.
| Value | Description |
|---|---|
| URL | Navigate to a URL. |
| Bookmark | Navigate to a bookmark within the document. |
TextFormat
Used by Read Text.
| Value | Description |
|---|---|
| PlainText | Extract plain text content. |
| Html | Extract content as HTML. |
| Rtf | Extract content in Rich Text Format (RTF). |
MatchColumnBy
Used by Fill Table.
| Value | Description |
|---|---|
| Index | Match DataTable columns to Word table columns by position. |
| Name | Match DataTable columns to Word table columns by name. |