UiPath.Word.Activities 2.4.1 — Activity Reference

Add Picture

UiPath.Word.Activities.DocumentAddImage

Word

Arguments

Name	Dir	Type	Req
ImagePath	In	`InArgument<String>`	✓
Text	In	`InArgument<String>`
Bookmark	In	`InArgument<String>`
OccurrenceIndex	In	`InArgument<Nullable<Int32>>`
FilePath	In	`InArgument<String>`	✓
PathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓

Properties

Name	Kind	Type
Occurrence	property	`UiPath.Word.Occurrence`
Position	property	`UiPath.Word.Position`
InsertRelativeTo	property	`UiPath.Word.InsertRelativeType`

Append Text

UiPath.Word.Activities.DocumentAppendText

Word

Write text at the end of a document.

Arguments

Name	Dir	Type	Req
Text	In	`InArgument<String>`	✓
FilePath	In	`InArgument<String>`	✓
PathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓

Properties

Name	Kind	Type	Description
NewLine	property	`Boolean`

Create New Document

UiPath.Word.Activities.DocumentCreateNew

Word

Creates a new document in the specified location

Arguments

Name	Dir	Type	Req
ConflictResolution	In	`InArgument<UiPath.Word.Activities.ConflictBehavior>`
Document	Out	`OutArgument<UiPath.Platform.ResourceHandling.IResource>`
FilePath	In	`InArgument<String>`	✓
PathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓

Insert DataTable in Document

UiPath.Word.Activities.DocumentInsertDataTable

Word

Arguments

Name	Dir	Type	Req
DataTable	In	`InArgument<Data.DataTable>`	✓
Text	In	`InArgument<String>`
Bookmark	In	`InArgument<String>`
OccurrenceIndex	In	`InArgument<Nullable<Int32>>`
FilePath	In	`InArgument<String>`	✓
PathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓

Properties

Name	Kind	Type
Occurrence	property	`UiPath.Word.Occurrence`
Position	property	`UiPath.Word.Position`
InsertRelativeTo	property	`UiPath.Word.InsertRelativeType`

Add Hyperlink to Document

UiPath.Word.Activities.DocumentInsertHyperlink

Word

Add a hyperlink to a Word document.

Arguments

Name	Dir	Type	Req
TextToDisplay	In	`InArgument<String>`	✓
Address	In	`InArgument<String>`	✓
TextToSearchFor	In	`InArgument<String>`
FilePath	In	`InArgument<String>`	✓
PathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓

Properties

Name	Kind	Type	Description
InsertRelativeTo	property	`UiPath.Word.InsertHyperlinkRelativeToType`
Position	property	`UiPath.Word.Position`

Read Text

UiPath.Word.Activities.DocumentReadText

Word

Read all text from a document.

Arguments

Name	Dir	Type	Req
Text	Out	`OutArgument<String>`
FilePath	In	`InArgument<String>`	✓
PathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓

Replace Picture

UiPath.Word.Activities.DocumentReplacePicture

Word

Replace picture(s) in a Word template, based on Alt Text.

Arguments

Name	Dir	Type	Req
PicturePath	In	`InArgument<String>`	✓
PictureAltText	In	`InArgument<String>`	✓
FilePath	In	`InArgument<String>`	✓
PathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓

Replace Text

UiPath.Word.Activities.DocumentReplaceText

Word

Arguments

Name	Dir	Type	Req
Search	In	`InArgument<String>`	✓
Replace	In	`InArgument<String>`	✓
Found	Out	`OutArgument<Boolean>`
FilePath	In	`InArgument<String>`	✓
PathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓

Set Bookmark Content

UiPath.Word.Activities.DocumentSetBookmarkContent

Word

Set the text in a document bookmark.

Arguments

Name	Dir	Type	Req
BookmarkName	In	`InArgument<String>`	✓
BookmarkText	In	`InArgument<String>`	✓
FilePath	In	`InArgument<String>`	✓
PathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓

Add Picture

UiPath.Word.Activities.WordAddImage

Word.Windows

Adds a picture at the end of a specified Word document.

Arguments

Name	Dir	Type	Req
ImagePath	In	`InArgument<String>`	✓
Text	In	`InArgument<String>`
Bookmark	In	`InArgument<String>`
OccurrenceIndex	In	`InArgument<Nullable<Int32>>`

Properties

Name	Kind	Type	Description
Occurrence	property	`UiPath.Word.Occurrence`
Position	property	`UiPath.Word.Position`

Add or Update Word Sensitivity Label

UiPath.Word.Activities.WordAddSensitivityLabel

Word.Windows

Adds or update sensitivity label on a Word document

Arguments

Name	Dir	Type	Req	Default	Description
SensitivityLabel	In	`InArgument<Object>`	✓
Justification	In	`InArgument<String>`

Append Text

UiPath.Word.Activities.WordAppendText

Word.Windows

Write text in a document at current caret position

Arguments

Name	Dir	Type	Req	Default	Description
Text	In	`InArgument<String>`	✓

Properties

Name	Kind	Type	Description
NewLine	property	`Boolean`

Word Application Scope

UiPath.Word.Activities.WordApplicationScope

Word.Windows

Open a Word document and provide a scope for other Word activities. When this activity ends, the document and the Word application are closed. If the specified file does not exist, a new document file is created.

Arguments

Name	Dir	Type	Req	Default	Description
FilePath	In	`InArgument<String>`	✓
SensitivityLabel	In	`InArgument<Object>`

Properties

Name	Kind	Type
CreateNewFile	property	`Boolean`
AutoSave	property	`Boolean`
ReadOnly	property	`Boolean`
SensitivityOperation	property	`UiPath.Word.WordLabelOperation`

Save Document as PDF

UiPath.Word.Activities.WordExportToPdf

Word.Windows

Exports a Word document to PDF.

Arguments

Name	Dir	Type	Req	Default	Description
FilePath	In	`InArgument<String>`	✓

Properties

Name	Kind	Type	Description
ReplaceExisting	property	`Boolean`

Get Word Sensitivity Label

UiPath.Word.Activities.WordGetSensitivityLabel

Word.Windows

Retrieves the sensitivity label from a Word document

Arguments

Name	Dir	Type	Req	Default	Description
SensitivityLabel	Out	`OutArgument<UiPath.Word.IWordLabelObject>`

Insert DataTable in Document

UiPath.Word.Activities.WordInsertDataTable

Word.Windows

The activity inserts a datatable relative to a text or a bookmark.

Arguments

Name	Dir	Type	Req
DataTable	In	`InArgument<Data.DataTable>`	✓
Text	In	`InArgument<String>`
Bookmark	In	`InArgument<String>`
OccurrenceIndex	In	`InArgument<Nullable<Int32>>`

Properties

Name	Kind	Type	Description
Position	property	`UiPath.Word.Position`
Occurrence	property	`UiPath.Word.Occurrence`

Add Hyperlink to Document

UiPath.Word.Activities.WordInsertHyperlink

Word.Windows

Add a hyperlink to a Word document.

Arguments

Name	Dir	Type	Req
TextToDisplay	In	`InArgument<String>`	✓
Address	In	`InArgument<String>`	✓
TextToSearchFor	In	`InArgument<String>`
Found	Out	`OutArgument<Boolean>`

Properties

Name	Kind	Type	Description
InsertRelativeTo	property	`UiPath.Word.InsertHyperlinkRelativeToType`
Position	property	`UiPath.Word.Position`

Paste Chart/Picture into Document

UiPath.Word.Activities.WordPasteFromClipboard

Word.Windows

Pastes a chart from the clipboard into a Word document at the specified position. Commonly used with "Copy Excel Chart to Clipboard".

Arguments

Name	Dir	Type	Req	Default	Description
Text	In	`InArgument<String>`
Found	Out	`OutArgument<Boolean>`

Properties

Name	Kind	Type
PasteRelativeTo	property	`UiPath.Word.PasteRelativeToType`
Position	property	`UiPath.Word.Position`
PasteOption	property	`UiPath.Word.PasteOptionType`

Read Text

UiPath.Word.Activities.WordReadText

Word.Windows

Read all text from a document.

Arguments

Name	Dir	Type	Req	Default	Description
Text	Out	`OutArgument<String>`	✓

Replace Picture

UiPath.Word.Activities.WordReplacePicture

Word.Windows

Replace picture(s) in a Word template, based on Alt Text.

Arguments

Name	Dir	Type	Req	Default	Description
PicturePath	In	`InArgument<String>`	✓
PictureAltText	In	`InArgument<String>`	✓

Replace Text

UiPath.Word.Activities.WordReplaceText

Word.Windows

Replace all occurrences of a text within a document with another text

Arguments

Name	Dir	Type	Req
Search	In	`InArgument<String>`	✓
Replace	In	`InArgument<String>`	✓
Found	Out	`OutArgument<Boolean>`

Properties

Name	Kind	Type	Description
ReplaceAll	property	`Boolean`

Save Document As

UiPath.Word.Activities.WordSaveAs

Word.Windows

Save a Word document as a different file.

Arguments

Name	Dir	Type	Req	Default	Description
FilePath	In	`InArgument<String>`	✓

Properties

Name	Kind	Type	Description
SaveAsFileType	property	`UiPath.Word.WordSaveAsType`
ReplaceExisting	property	`Boolean`

Set Bookmark Content

UiPath.Word.Activities.WordSetBookmarkContent

Word.Windows

Set the text in a document bookmark.

Arguments

Name	Dir	Type	Req	Default	Description
BookmarkName	In	`InArgument<String>`	✓
BookmarkText	In	`InArgument<String>`	✓

Set content property

UiPath.Word.Activities.WordSetContentProperty

Word.Windows

Sets the value of a content control property in the Word document by matching Text, Title, or Tag.

Arguments

Name	Dir	Type	Req	Default
MatchBy	In	`InArgument<UiPath.Word.MatchPropertyBy>`	✓	`Mono.Cecil.CustomAttributeArgument`
MatchTo	In	`InArgument<String>`	✓
Value	In	`InArgument<String>`	✓
Found	Out	`OutArgument<Boolean>`

Properties

Name	Kind	Type	Description
ReplaceAll	property	`Boolean`