Add Hyperlink to Document

UiPath.Word.Activities.WordInsertHyperlink

Description

Adds a hyperlink to a document. This activity must be added inside a Use Word File activity.

Configuring the activity

In the body of the activity

• Text to display - The text displayed in the document representing the hyperlink. Click Plus on the right side of the field, and then, from the menu, choose one of the available options to indicate the text to be displayed:

  • Data from the Project Notebook, a parent Excel file or Outlook account. For example, select an Excel file, and then select a cell that contains the text, or indicate a field from a selected email in Outlook that contains the text.
  • Ask when run - Prompt for the text when the project is executed.
  • Paste from clipboard - Paste text that you previously copied to the clipboard in the project.
  • Text - Enter the text in the Text Builder.
  • Use Saved Value - Select a value that you previously saved for later use in the project.
  • Open in Advanced Editor - Enter a VB expression.

• Address - The address of the hyperlink. Click Plus on the right side of the field, and then, from the menu, choose one of the available options to indicate the address:

  • Data from the Project Notebook, a parent Excel file or Outlook account. For example, select an Excel file, and then select a cell that contains the address, or indicate a field from a selected email in Outlook that contains the address.
  • Ask when run - Prompt for the address when the project is executed.
  • Paste from clipboard - Paste an address that you previously copied to the clipboard in the project.
  • Text - Enter the address in the Text Builder.
  • Use Saved Value - Select a value that you previously saved for later use in the project.
  • Open in Advanced Editor - Enter a VB expression.

• Insert relative to - Select whether the hyperlink should be added relative to the doocument or to a piece of text.

• Position where to insert - The position where the hyperlink should be added. Depending on what you selected in the Insert relative to field, the following placement options are available:

  • Document:
    • Start
    • End
  • Text:
    • Before
    • After
    • Replace
  • Text to search for - The text relative to which the hyperlink should be added. Click Plus   on the right side of the field, and then, from the menu, choose one of the available options to indicate the text to be displayed:
    • Data from the Project Notebook, a parent Excel file or Outlook account. For example, select an Excel file, and then select a cell that contains the text, or indicate a field from a selected email in Outlook that contains the text.
    • Ask when run - Prompt for the text when the project is executed.
    • Paste from clipboard - Paste text that you previously copied to the clipboard in the project.
    • Text - Enter the text in the Text Builder.
    • Use Saved Value - Select a value that you previously saved for later use in the project.
    • Open in Advanced Editor - Enter a VB expression.

Properties panel

Common

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

Insert Options

• See the options in the body of the activity

Misc

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

Result

• Found - Indicates if the hyperlink was successfully added to the document.