MS Excel - Form Operations for UiPath Studio

Description

Provides functions for interacting with forms and form controls in MS Excel workbooks. Please note these activities are not mandatory to be used within Excel application scope. The Excel sheet gets attached to the UiPath with the workbook name provided as input.

Prerequisites

NA

Execution

Kindly import the NuGet package to use the activities

Inputs 

FormListboxAndComboboxGetProperties

WorksheetName (string) - Optional. Default to be the active Worksheet

WorkbookName (string) - Optional. Default to be the active Worksheet.

ListboxName (string) - Required. The Internal name of the listbox. Like: "List Box 2".

FormListboxAndComboboxSelect

WorksheetName (string) - Optional. Default to be the active Worksheet

WorkbookName (string) - Optional. Default to be the active Worksheet.

ListboxName (string) - Required. The Internal name of the listbox. Like: "List Box 2".

SelectIndex (int) - Required. Select which item, starts from 1.

FormOptionButtonClick

WorksheetName (string) - Optional. Default to be the active Worksheet

WorkbookName (string) - Optional. Default to be the active Worksheet.

Status (bool) - Optional. Default to be false. True means set the button to be selected.

OptionButtonName (string) - Required. The Internal name of the OptionButton. Like: "Option Button 1"

FormCheckboxClick

WorksheetName (string) - Optional. Default to be the active Worksheet

WorkbookName (string) - Optional. Default to be the active Worksheet.

Status (bool) - Optional. Default to be false. True means set the checkbox to be checked

CheckboxName (string) - Required. The Internal name of the Checkbox. Like: "Check Box 9"

FormScrollbarGetProperties

WorksheetName (string) - Optional. Default to be the active Worksheet

WorkbookName (string) - Optional. Default to be the active Worksheet.

ScrollbarName (string) - Required. The Internal name of the Checkbox. Like: "Check Box 9"

FormScrollBarSmallScroll

WorksheetName (string) - Optional. Default to be the active Worksheet.

WorkbookName (string) - Optional. Default to be the active Worksheet.

ScrollbarName (string) - Required. The Internal name of the Checkbox. Like: "Check Box 9".

SmallOrLargeMove (bool) - Optional. Default to be false. True means moving step is "Page change", False means moving step is "Incremental change".

MoveTimes (int) - Optional. Default to be 1. Positive value makes scrollbar move down/right ward; Negative value makes scroll bar move up/left ward.

OpenWorkbookByPassword

WorkbookFullPath (string) - Required.Full Path of Workbook

Password (string) - Optional. If no password, just leave it empty.

MaxTimeForWaiting (int) - Optional. Default to be 120s.

CloseAllInstances

Nil

Outputs

FormListboxAndComboboxGetProperties

ListRangeCollection (DataTable) - The value of the range that linked to this list box

ListRange (string) - The range that linked to this list box

ListArray (DataTable) - The displayed list of this list box

ListIndex (int) - Selected index

LinkedCellAddress (string) - The address of the cell that is linked to this list box

FormListboxAndComboboxSelect

Success (bool) – True if succeeded

ErrorMes (string) – Error message if any

FormOptionButtonClick

Success (bool) – True if succeeded

ErrorMes (string) – Error message if any

FormCheckboxClick

Success (bool) – True if succeeded

ErrorMes (string) – Error message if any

FormScrollbarGetProperties

CurrentScrollValue (int) – Current value of the scroll bar

SmallChangeStep (int) – Incremental change of the scroll

bar LargeChangeStep (int) – Page change of the scroll bar

MinValue (int) – Minimum value

MaxValue (int) – Maximum value

FormScrollBarSmallScroll

Success (bool) – True if succeeded

ErrorMes (string) – Error message if any

CurrentScrollValue (int) – CurrentScrollValue

OpenWorkbookByPassword

WorkbookFullPath (string) - Required.Full Path of Workbook

Password (string) - Optional. If no password, just leave it empty.

MaxTimeForWaiting (int) - Optional. Default to be 120s.

CloseAllInstances

Nil

Components Included

Process

Main

NuGet Package

MSExcelFormOperations

List of Functionality

FormListboxAndComboboxGetProperties

Get ListFillRange, ListRangeCollection, ListArray, ListIndex, LinkedCellAddress and LinkedCellValue from Listbox or Combobox as the output.

FormListboxAndComboboxSelect

Select an item in the listbox or Combobox. This action will not trigger the "change" event.

SelectIndex Starts from 1. If the SelectIndex is out of the selection range, an error message will pop out.

FormOptionButtonClick

OptionButton is Radio Button. This action is used to select an OptionButton or not.

FormCheckboxClick

Check a checkbox or not.

FormScrollbarGetProperties

Get CurrentScrollValue, SmallChangeStep, LargeChangeStep, MinValue, MaxValue of the scrollbar

FormScrollBarSmallScroll

Make scrollbar move forward or backward by small incremental change or page change

OpenWorkbookByPassword

The handler is from the default instance which is the first instance. This function could open the Excel file directly from Remove Server by using the http or https path or UNC path, while the standard Excel VBO could only use UNC path.

CloseAllInstances

Closes all instances of excel which have been opened by this business object, either through "Create Instance" or "Open Instance" and which have not been discarded through "Close Instance" or "Release Instance"