MicrosoftWord connector
Use the MicrosoftWord connector in automations to write and read text from bookmarked documents or templates.
When you add this component to an automation, the system places it in the Globals container for the project, so it can be referenced by other automations in the project.
Properties
| Property | Description |
| Changes | Specifies the Save Changes action that you want the system to take when the document is closed. The options are:
|
| Document | Use the Document property to specify the file name of the document that you want to use in the solution. You must specify a document to use the component. By default, Robot Studio looks at the exact file path selected. However, the Folder property lets you determine the folder file path that is resolved at runtime using predefined tokens. You select these tokens from a list that includes options such as Deployment, Temporary, and System. The folder file path is then resolved by the selected token instead.
|
| Mode | Mode governs how the connector file is opened. When set to Create (the default), Robot Studio creates a file if it does not already exist. The Open setting ensures a file is not created, but tries to open the designated file instead. If there is no document present when Robot Studio tries to open it, the system shows an error message. |
| Template | Use the Template property to specify the template you want to use in the solution. You can either work withdocuments or templates. The Folder property works the same for a template or a document. |
| SupportedName | Indicates the corresponding Microsoft Office name for the Word program in the automation. |
| SupportedVersion | Displays the version number of the Word program in the automation. |
| Version | Indicates the current running version of Microsoft Word. |
| Visible | Visible is a Boolean property that indicates whether or not the main Word window is visible during solution runtime. |
| WordApplication | Microsoft Word COM instance. |
| WordDocument | Microsoft Word document COM instance. |
Methods
| Method | Description | Parameters | Result type |
| Close | Closes a currently opened document. | None | Void |
| Open (1 Parameter) | Opens a new document using the file name that you enter. | String document | Void |
| ResetState | Resets all component properties to their initial values. | None | Void |
| RunMacro (1 Parameter) | Runs a Visual Basic macro or calls a function. | String Macroname | Object |
| RunMacro (6 Parameters) | Runs a Visual Basic macro or calls a function. All param1-param5 parameters are optional. | String + Optional Parameters | Object |
| Save | Saves the currently opened document. Returns a True result if the document is successfully saved. | None | Boolean |
| SaveAs | Saves the currently opened document under a new file name. If you
do not specify the path, the document is saved in the My
Documents folder for the user. Returns a
True result if the document is
successfully saved. | String Filename | Boolean |
Events
| Event | Description |
| AfterMailMerge | Occurs after a mail-merge operation ends. |
| BeforeMailMerge | Occurs before a mail-merge operation ends. |
| DocumentChanged | Occurs when the automation creates a document, opens a document, or makes another document the active document. |
| DocumentClosed | Occurs when the automation closes the current document. |
| DocumentOpened | Occurs when the automation opens a document. |
| DocumentPrinted | Occurs when the automation prints the current document. |
| DocumentSaved | Occurs when the automation saves the current document. |
| NewDocument | Occurs when the automation creates a document. |
| Quit | Occurs when the automation closes the main Word window manually. |
| SelectionChange | Occurs when the current document selection changes. |
| WindowActivate | Occurs when the automation activates the Word main window. |
| WindowDeactivate | Occurs when the automation deactivates the Word main window. |
Previous topic MicrosoftPowerPoint connector Next topic OCR methods