Word Root
AutomatR.Word.WordRoot
The "Word Root" activity in AutomatR is part of the Word activities package, designed to select a Word document for use in the automation process. This activity establishes a scope for working with Word documents, enabling subsequent activities to perform actions within the selected document.
Properties
Name | Description |
---|---|
Input | |
FilePath | Enter the full path of the Word document on the local drive, including the filename (e.g., "C:\WordActivities\word.docx"). String variables containing the file path. |
Visible | Determines whether the Word application is visible during the automation process. Boolean variables to set the visibility. |
Password | Enter the password for the Word document if required. String variables containing the document password. |
Misc | |
Display Name | Provides a customizable name for the activity displayed in the workflow. Enhances clarity and organization within the automation project. String variables containing the desired display name. |
Optional | |
Delay | Specifies the amount of time (in seconds) to wait before starting the activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
Output | |
Word | Outputs the Word application instance, allowing subsequent activities to perform actions within the Word document. Variables of type Microsoft.Office.Interop.Word.Application to store the Word application instance. |
How to use:
- Drag and drop the "Word Root" activity onto the workflow.
- Configure the properties by specifying the Word document's file path, delay, visibility, and password (if required).
- Optionally, configure the delay before starting the activity and set the visibility of the Word application.
- Execute the workflow to establish a scope for working with the selected Word document.
Example:
Consider an example where the "Word Root" activity is used to work with a Word document located at "C:\Documents\Sample.docx" with a delay of 2 seconds and the Word application set to be visible:
Word Root:
FilePath: "C:\Documents\Sample.docx"
Delay: 2
Visible: true
Password: "your_password"
Word: wordAppInstance
In this example, the activity selects the Word document at the specified file path, waits for 2 seconds before starting, sets the Word application to be visible, and uses the password "your_password" if required. The Word application instance is stored in the variable "wordAppInstance" for further actions in the workflow.