Word Application Scope / Use Word File

UiPath.Word.Activities.WordApplicationScope

In the StudioX profile, this activity is named Use Word File. In the Studio profile, this activity is named Word Application Scope.

Description

Lets you select a Word document to use in the automation. After you add the activity and indicate the file, add the Word activities to perform on the file inside this activity. If the specified file does not exist, the file is created when the project is executed. When this activity ends, the document and the Word application are closed.

If the activity is added inside a Use Excel File, Use Outlook 365, Use Gmail, or Use Desktop Outlook App activity, you can select data from that Excel file or email account when configuring the activities added inside Use Word File.

You can add UI Automation activities directly in the Use Word File activity to quickly automate the interface of Word. For this to work, you need to have the Word document open on your machine.

To learn how to use this activity:

• Create a project using the Complete Word Template from Excel and Email project template.
• See Tutorial: Working with Word Automation.

Configuring the Activity

In the Body of the Activity

• Word file - Click Browse next to the field, and then browse to and select a Word document. Alternatively, you can provide the file path using one of the options in the Plus menu on the right side of the field. For example, select a cell in the Project Notebook that contains a path to a Word document or select Ask when run to enter a path manually when the project is executed. You can also input the SharePoint URL of a word file.
• Create if not exists - If selected, a new Word document is created if the file is not found at the specified path. If not selected, an error occurs if the file is not found at the specified path. This option is selected by default.
• Save changes - If selected, the document is saved on each change caused by an activity. If not selected, the changes are saved only after all the activities added inside Use Word File are executed. This option is selected by default.

Properties Panel

Common

• DisplayName - The name displayed for the activity in the Designer panel.

File

• File path - Refer to Word file in the body of the activity.

Misc

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Options

• Auto save - Refer to Save changes in the body of the activity.
• Create if not exists - Refer to Create if not exists in the body of the activity.
• ReadOnly - If selected, the Word document is opened in a read-only mode. This can be used if the document is locked for editing or to avoid making changes when only needing to read data.
• Sensitivity label - The string ID of the sensitivity label or an instance of the Word label object. It is used only when the sensitivity operation is Add. Otherwise, it is ignored.
• Sensitivity operation - The sensitivity operation to be applied using the sensitivity label. Use the dropdown to choose between the following options: Do nothing, Add/Update, or Clear.

  For more information, refer to Working with sensitivity labels.