UiPath.Excel.Activities 3.4.1 — Activity Reference

Append to CSV

UiPath.CSV.Activities.AppendCsvFile

Excel.CSV

Copies an Excel range, table, or sheet, or table data saved for later, and pastes it after existing data in a specified CSV file

Arguments

Name	Dir	Type	Req
FilePath	In	`InArgument<String>`	✓
DataTable	In	`InArgument<Data.DataTable>`	✓
Encoding	In	`InArgument<String>`

Properties

Name	Kind	Type	Description
Delimitator	property	`UiPath.CSV.DelimitatorOptions`

Write CSV

UiPath.CSV.Activities.AppendWriteCsvFile

Excel.CSV

Copies an Excel range, table, or sheet, or table data saved for later, and pastes it in a specified CSV file either pasting it after existing data or replacing any existing data in the file.

Arguments

Name	Dir	Type	Req
FilePath	In	`InArgument<String>`	✓
PathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
DataTable	In	`InArgument<Data.DataTable>`	✓
Encoding	In	`InArgument<String>`

Properties

Name	Kind	Type
CsvAction	property	`UiPath.CSV.Activities.CsvWriteAction`
Delimitator	property	`UiPath.CSV.DelimitatorOptions`
AddHeaders	property	`Boolean`
ShouldQuote	property	`Boolean`

Read CSV

UiPath.CSV.Activities.ReadCsvFile

Excel.CSV

Copies all entries from a specified CSV file to an Excel range, table, or sheet, or saves the data for later use in the automation.

Arguments

Name	Dir	Type	Req
FilePath	In	`InArgument<String>`	✓
PathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
DataTable	Out	`OutArgument<Data.DataTable>`
Encoding	In	`InArgument<String>`
IgnoreQuotes	In	`InArgument<Boolean>`

Properties

Name	Kind	Type	Description
Delimitator	property	`UiPath.CSV.DelimitatorOptions`
IncludeColumnNames	property	`Boolean`

Write CSV

UiPath.CSV.Activities.WriteCsvFile

Excel.CSV

Copies an Excel range, table, or sheet, or table data saved for later, and pastes it in a specified CSV file replacing any existing data in the file

Arguments

Name	Dir	Type	Req
Encoding	In	`InArgument<String>`
FilePath	In	`InArgument<String>`	✓
DataTable	In	`InArgument<Data.DataTable>`	✓

Properties

Name	Kind	Type
AddHeaders	property	`Boolean`
ShouldQuote	property	`Boolean`
Delimitator	property	`UiPath.CSV.DelimitatorOptions`

Append Range Workbook

UiPath.Excel.Activities.AppendRange

Excel

Appends the data from a DataTable to a spreadsheet. If the sheet does not exist, a new one is created with the SheetName value. Changes are immediately saved

Arguments

Name	Dir	Type	Req	Default
DataTable	In	`InArgument<Data.DataTable>`	✓
SheetName	In	`InArgument<String>`	✓	`Sheet1`
WorkbookPath	In	`InArgument<String>`	✓
WorkbookPathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
Password	In	`InArgument<String>`

Arguments — Use Workbook

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.Workbook>`

Create New Workbook

UiPath.Excel.Activities.CreateNewWorkbook

Excel

Creates a new workbook with a new empty sheet.

Arguments

Name	Dir	Type	Req	Default
ConflictResolution	In	`InArgument<UiPath.Excel.ConflictBehavior>`
WorkbookFile	Out	`OutArgument<UiPath.Excel.Workbook>`
SheetName	In	`InArgument<String>`	✓	`Sheet1`
WorkbookPath	In	`InArgument<String>`	✓
WorkbookPathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
Password	In	`InArgument<String>`

Arguments — Use Workbook

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.Workbook>`

Create Pivot Table Workbook

UiPath.Excel.Activities.CreatePivotTable

Excel

Creates a pivot table from a specified range or table to help you calculate, summarize, and analyze data.

Arguments

Name	Dir	Type	Req	Default
SourceSheet	In	`InArgument<String>`
SourceRange	In	`InArgument<String>`
SourceTable	In	`InArgument<String>`
PivotTableName	In	`InArgument<String>`	✓
PlacementCell	In	`InArgument<String>`
LayoutRowType	In	`InArgument<UiPath.Excel.PivotTableLayoutRowType>`
ValuesMode	In	`InArgument<UiPath.Excel.PivotTableValuesMode>`
PivotTableFieldsVariable	In	`InArgument<IEnumerable<UiPath.Excel.PivotTableField>>`
SheetName	In	`InArgument<String>`	✓	`Sheet1`
WorkbookPath	In	`InArgument<String>`	✓
WorkbookPathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
Password	In	`InArgument<String>`

Arguments — Use Workbook

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.Workbook>`

Properties

Name	Kind	Type	Description
UseTableSource	property	`Boolean`
PivotTableFields	property	`List<InArgument<UiPath.Excel.PivotTableField>>`

Get Cell Color Workbook

UiPath.Excel.Activities.GetCellColor

Excel

Gets the color of a cell

Arguments

Name	Dir	Type	Req	Default
Cell	In	`InArgument<String>`	✓
Color	Out	`OutArgument<Drawing.Color>`
SheetName	In	`InArgument<String>`	✓	`Sheet1`
WorkbookPath	In	`InArgument<String>`	✓
WorkbookPathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
Password	In	`InArgument<String>`

Arguments — Use Workbook

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.Workbook>`

Get Sheets Workbook

UiPath.Excel.Activities.GetSheets

Excel

Returns the sheets from the workbook

Arguments

Name	Dir	Type	Req
Result	Out	`OutArgument<IEnumerable<String>>`
WorkbookPath	In	`InArgument<String>`	✓
WorkbookPathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
Password	In	`InArgument<String>`

Arguments — Use Workbook

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.Workbook>`

Properties

Name	Kind	Type	Description
OnlyVisibleSheets	property	`Boolean`

Get Table Range Workbook

UiPath.Excel.Activities.GetTableRange

Excel

Extracts the range of an Excel table from a specified spreadsheet

Arguments

Name	Dir	Type	Req	Default
TableName	In	`InArgument<String>`	✓
Range	Out	`OutArgument<String>`
SheetName	In	`InArgument<String>`	✓	`Sheet1`
WorkbookPath	In	`InArgument<String>`	✓
WorkbookPathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
Password	In	`InArgument<String>`

Arguments — Use Workbook

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.Workbook>`

Properties

Name	Kind	Type	Description
IsPivot	property	`Boolean`

Read Cell Workbook

UiPath.Excel.Activities.ReadCell

Excel

Reads the value of a cell from a spreadsheet as a string

Arguments

Name	Dir	Type	Req	Default
Cell	In	`InArgument<String>`	✓	`A1`
Result	Out	`OutArgument`
SheetName	In	`InArgument<String>`	✓	`Sheet1`
WorkbookPath	In	`InArgument<String>`	✓
WorkbookPathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
Password	In	`InArgument<String>`

Arguments — Use Workbook

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.Workbook>`

Properties

Name	Kind	Type	Description
PreserveFormat	property	`Boolean`

Read Cell Formula Workbook

UiPath.Excel.Activities.ReadCellFormula

Excel

Reads the formula of a cell from a spreadsheet as a string

Arguments

Name	Dir	Type	Req	Default
Cell	In	`InArgument<String>`	✓	`A1`
Result	Out	`OutArgument<String>`
SheetName	In	`InArgument<String>`	✓	`Sheet1`
WorkbookPath	In	`InArgument<String>`	✓
WorkbookPathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
Password	In	`InArgument<String>`

Arguments — Use Workbook

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.Workbook>`

Read Column Workbook

UiPath.Excel.Activities.ReadColumn

Excel

Reads the values from a column beginning from the cell specified in the StartingCell field, and stores them in an IEnumerable <object>variable

Arguments

Name	Dir	Type	Req	Default
StartingCell	In	`InArgument<String>`	✓	`A1`
Result	Out	`OutArgument<IEnumerable<Object>>`
SheetName	In	`InArgument<String>`	✓	`Sheet1`
WorkbookPath	In	`InArgument<String>`	✓
WorkbookPathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
Password	In	`InArgument<String>`

Arguments — Use Workbook

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.Workbook>`

Properties

Name	Kind	Type	Description
PreserveFormat	property	`Boolean`

Read Range Workbook

UiPath.Excel.Activities.ReadRange

Excel

Reads the value of a range in Range Excel Format from a spreadsheet as a DataTable. If Range isn't specified, the whole spreadsheet is read. If range is specified as a cell, the whole spreadsheet starting from that cell is read

Arguments

Name	Dir	Type	Req	Default
Range	In	`InArgument<String>`		`A1:A2`
DataTable	Out	`OutArgument<Data.DataTable>`
SheetName	In	`InArgument<String>`	✓	`Sheet1`
WorkbookPath	In	`InArgument<String>`	✓
WorkbookPathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
Password	In	`InArgument<String>`

Arguments — Use Workbook

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.Workbook>`

Properties

Name	Kind	Type	Description
AddHeaders	property	`Boolean`
PreserveFormat	property	`Boolean`

Read Row Workbook

UiPath.Excel.Activities.ReadRow

Excel

Reads the values of an Excel row beginning from the cell specified in the StartingCell field, and stores it in an IEnumerable<object> variable

Arguments

Name	Dir	Type	Req	Default
StartingCell	In	`InArgument<String>`	✓	`A1`
Result	Out	`OutArgument<IEnumerable<Object>>`
SheetName	In	`InArgument<String>`	✓	`Sheet1`
WorkbookPath	In	`InArgument<String>`	✓
WorkbookPathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
Password	In	`InArgument<String>`

Arguments — Use Workbook

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.Workbook>`

Properties

Name	Kind	Type	Description
PreserveFormat	property	`Boolean`

Set Range Color Workbook

UiPath.Excel.Activities.SetRangeColor

Excel

Sets the color of a range

Arguments

Name	Dir	Type	Req	Default
Range	In	`InArgument<String>`	✓
Color	In	`InArgument<Drawing.Color>`	✓
SheetName	In	`InArgument<String>`	✓	`Sheet1`
WorkbookPath	In	`InArgument<String>`	✓
WorkbookPathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
Password	In	`InArgument<String>`

Arguments — Use Workbook

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.Workbook>`

Write Cell Workbook

UiPath.Excel.Activities.WriteCell

Excel

Writes the Text value into a cell from a spreadsheet. If the sheet does not exist, a new one is created with the SheetName value. If a value exists, it is overwritten. Changes are immediately saved

Arguments

Name	Dir	Type	Req	Default
Cell	In	`InArgument<String>`	✓	`A1`
Text	In	`InArgument<String>`	✓
SheetName	In	`InArgument<String>`	✓	`Sheet1`
WorkbookPath	In	`InArgument<String>`	✓
WorkbookPathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
Password	In	`InArgument<String>`

Arguments — Use Workbook

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.Workbook>`

Write Range Workbook

UiPath.Excel.Activities.WriteRange

Excel

Writes the data from a DataTable in a spreadsheet starting from StartingCell. If StartingCell isn't specified, the writing begins at A1 cell. If the sheet does not exist, a new one is created with the SheetName value. All cells within the DataTable range are overwritten. Changes are immediately saved

Arguments

Name	Dir	Type	Req	Default
StartingCell	In	`InArgument<String>`		`A1`
DataTable	In	`InArgument<Data.DataTable>`	✓
SheetName	In	`InArgument<String>`	✓	`Sheet1`
WorkbookPath	In	`InArgument<String>`	✓
WorkbookPathResource	In	`InArgument<UiPath.Platform.ResourceHandling.IResource>`	✓
Password	In	`InArgument<String>`

Arguments — Use Workbook

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.Workbook>`

Properties

Name	Kind	Type	Description
AddHeaders	property	`Boolean`

Get Cell Color

UiPath.Excel.Activities.GetCellColorX

Excel.Windows.Cell

Extracts the background color of a cell and saves it as a Color variable.

Arguments

Name	Dir	Type	Req	Default	Description
Cell	In	`InArgument<UiPath.Excel.IReadCellRef>`	✓
OutputColor	Out	`OutArgument<Drawing.Color>`

Get Selected Range

UiPath.Excel.Activities.Windows.Business.GetSelectedRangeX

Excel.Windows.Range

Get the selected range from the target Excel file.

Arguments

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.IWorkbookQuickHandle>`	✓
Range	Out	`OutArgument<UiPath.Excel.IReadRangeRef>`

Select Range

UiPath.Excel.Activities.Windows.Business.SelectRangeX

Excel.Windows.Range

Selects a range in the specified Excel file.

Arguments

Name	Dir	Type	Req	Default	Description
Range	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓

Add or Update Excel Sensitivity Label

UiPath.Excel.Activities.Business.AddSensitivityLabelX

Excel.Windows.Workbook

Adds a sensitivity label to an Excel file

Arguments

Name	Dir	Type	Req
Workbook	In	`InArgument<UiPath.Excel.IWorkbookQuickHandle>`	✓
SensitivityLabel	In	`InArgument<Object>`	✓
Justification	In	`InArgument<String>`

Append Range

UiPath.Excel.Activities.Business.AppendRangeX

Excel.Windows.Range

Copies the data in a table, range, or sheet and pastes it after existing data in another specified table, range, or sheet.

Arguments

Name	Dir	Type	Req
SourceRange	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓
DestinationRange	In	`InArgument<UiPath.Excel.IReadWriteRangeRef>`	✓
StartingColumnName	In	`InArgument<String>`

Properties

Name	Kind	Type
PasteOptions	property	`UiPath.Excel.CopyPasteRangeOptions`
Transpose	property	`Boolean`
HasHeaders	property	`Boolean`
DestinationHasHeaders	property	`Boolean`

Auto Fill

UiPath.Excel.Activities.Business.AutoFillX

Excel.Windows.Cell

Fills cells with data based on data in other cells using the AutoFill feature in Excel.

Arguments

Name	Dir	Type	Req	Default	Description
StartRange	In	`InArgument<UiPath.Excel.IWellDefinedReadRangeRef>`	✓

Autofit Range

UiPath.Excel.Activities.Business.AutoFitX

Excel.Windows.Range

Fits data in cells.

Arguments

Name	Dir	Type	Req	Default	Description
Range	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓

Properties

Name	Kind	Type	Description
Columns	property	`Boolean`
Rows	property	`Boolean`

Change Pivot Data Source

UiPath.Excel.Activities.Business.ChangePivotTableDataSourceX

Excel.Windows.Pivot Table

Change the Source range for a Pivot Table.

Arguments

Name	Dir	Type	Req	Default	Description
PivotTable	In	`InArgument<UiPath.Excel.IPivotTableRef>`	✓
NewSourceRange	In	`InArgument<UiPath.Excel.IWellDefinedReadRangeRef>`	✓

Clear Sheet/Range/Table

UiPath.Excel.Activities.Business.ClearRangeX

Excel.Windows.Range

Clears the data from a spreadsheet sheet, range, or table.

Arguments

Name	Dir	Type	Req	Default	Description
TargetRange	In	`InArgument<UiPath.Excel.IReadWriteRangeRef>`	✓

Properties

Name	Kind	Type	Description
HasHeaders	property	`Boolean`

Create Pivot Table

UiPath.Excel.Activities.Business.CreatePivotTableX

Excel.Windows.Pivot Table

Creates a pivot table from a specified range or table to help you calculate, summarize, and analyze data.

Arguments

Name	Dir	Type	Req
Range	In	`InArgument<UiPath.Excel.IWellDefinedReadRangeRef>`	✓
TableName	In	`InArgument<String>`	✓
DestinationRange	In	`InArgument<UiPath.Excel.IReadWriteRangeRef>`	✓

Properties

Name	Kind	Type	Description
LayoutRowType	property	`UiPath.Excel.PivotTableLayoutRowType`
ValuesMode	property	`UiPath.Excel.PivotTableValuesMode`

Child Activities / Variable Scope

Name	Kind	Type	Description
Body	child	`ActivityAction`

For Each Excel Row

UiPath.Excel.Activities.Business.ExcelForEachRow

Excel.Windows.Range

Repeats the contained activities once for each row in the specified sheet, range, or table.

Arguments

Name	Dir	Type	Req	Default	Description
Range	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓

Properties

Name	Kind	Type
HasHeaders	property	`Boolean`
EmptyRowBehavior	property	`UiPath.Excel.EmptyRowBehavior`
SaveAfterEachRow	property	`Boolean`

Child Activities / Variable Scope

Name	Kind	Type	Description
Body	child	`ActivityAction<UiPath.Excel.CurrentRowQuickHandle, Int32>`

Get Chart

UiPath.Excel.Activities.Business.CopyChartToClipboardX

Excel.Windows.Chart

Saves an Excel chart to an image file or to the clipboard for use in other activities.

Arguments

Name	Dir	Type	Req	Default	Description
Chart	In	`InArgument<UiPath.Excel.IChartRef>`	✓
FilePath	In	`InArgument<String>`

Properties

Name	Kind	Type	Description
Action	property	`UiPath.Excel.ExcelChartAction`
ReplaceFile	property	`Boolean`

Copy/Paste Range

UiPath.Excel.Activities.Business.CopyPasteRangeX

Excel.Windows.Range

Copies a range or sheet and optionally pastes it to another location in the current workbook or a different one.

Arguments

Name	Dir	Type	Req	Default	Description
SourceRange	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓
DestinationRange	In	`InArgument<UiPath.Excel.IReadWriteRangeRef>`	✓

Properties

Name	Kind	Type
PasteOptions	property	`UiPath.Excel.CopyPasteRangeOptions`
ExcludeHeaders	property	`Boolean`
ExcludeHeaderFromSourceTable	property	`Boolean`
Transpose	property	`Boolean`

Create Pivot Table

UiPath.Excel.Activities.Business.CreatePivotTableXv2

Excel.Windows.Pivot Table

Creates a pivot table from a specified range or table to help you calculate, summarize, and analyze data.

Arguments

Name	Dir	Type	Req
Range	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓
TableName	In	`InArgument<String>`	✓
DestinationRange	In	`InArgument<UiPath.Excel.IReadWriteRangeRef>`	✓

Properties

Name	Kind	Type	Description
LayoutRowType	property	`UiPath.Excel.PivotTableLayoutRowType`
ValuesMode	property	`UiPath.Excel.PivotTableValuesMode`

Child Activities / Variable Scope

Name	Kind	Type	Description
Body	child	`ActivityAction`

Format as Table

UiPath.Excel.Activities.Business.CreateTableX

Excel.Windows.Range

Formats a range of cells as a table with a specified name.

Arguments

Name	Dir	Type	Req
Range	In	`InArgument<UiPath.Excel.IReadWriteRangeRef>`	✓
TableName	In	`InArgument<String>`
OutTableName	Out	`OutArgument<String>`

Properties

Name	Kind	Type	Description
HasHeaders	property	`Boolean`
ReplaceExisting	property	`Boolean`

Delete Column

UiPath.Excel.Activities.Business.DeleteColumnX

Excel.Windows.Range

Deletes a specified column from a sheet, table or range.

Arguments

Name	Dir	Type	Req	Default	Description
Range	In	`InArgument<UiPath.Excel.IReadWriteRangeRef>`	✓
ColumnName	In	`InArgument<String>`	✓

Properties

Name	Kind	Type	Description
HasHeaders	property	`Boolean`

Delete Rows

UiPath.Excel.Activities.Business.DeleteRowsX

Excel.Windows.Range

Deletes the specified rows from a sheet, table, or range.

Arguments

Name	Dir	Type	Req	Default	Description
Range	In	`InArgument<UiPath.Excel.IReadWriteRangeRef>`	✓
RowPositions	In	`InArgument<String>`

Properties

Name	Kind	Type	Description
DeleteRowsOption	property	`UiPath.Excel.DeleteRowsOption`
HasHeaders	property	`Boolean`

Delete Sheet

UiPath.Excel.Activities.Business.DeleteSheetX

Excel.Windows.Workbook

Deletes a specified sheet from an Excel file.

Arguments

Name	Dir	Type	Req	Default	Description
Sheet	In	`InArgument<UiPath.Excel.ISheetRef>`	✓

Duplicate Sheet

UiPath.Excel.Activities.Business.DuplicateSheetX

Excel.Windows.Workbook

Creates a copy of the specified sheet in an Excel file.

Arguments

Name	Dir	Type	Req	Default	Description
SheetToDuplicate	In	`InArgument<UiPath.Excel.ISheetRef>`	✓
NewSheetName	In	`InArgument<String>`	✓

Use Excel File

UiPath.Excel.Activities.Business.ExcelApplicationCard

Excel.Windows

Open or create an Excel file to use in your automation.

Arguments

Name	Dir	Type	Req
WorkbookPath	In	`InArgument<String>`	✓
Password	In	`InArgument<String>`
SecurePassword	In	`InArgument<Security.SecureString>`
EditPassword	In	`InArgument<String>`
SecureEditPassword	In	`InArgument<Security.SecureString>`
SensitivityLabel	In	`InArgument<Object>`

Properties

Name	Kind	Type
CreateNewFile	property	`Boolean`
AutoSave	property	`Boolean`
ReadOnly	property	`Boolean`
KeepExcelFileOpen	property	`Boolean`
ReadFormatting	property	`Nullable<UiPath.Excel.ReadFormattingOptions>`
ResizeWindow	property	`UiPath.Excel.Model.ResizeWindowOptions`
SensitivityOperation	property	`UiPath.Excel.ExcelLabelOperation`

Child Activities / Variable Scope

Name	Kind	Type	Description
Body	child	`ActivityAction<UiPath.Excel.IWorkbookQuickHandle>`

For Each Excel Row

UiPath.Excel.Activities.Business.ExcelForEachRowX

Excel.Windows.Range

Repeats the contained activities once for each row in the specified sheet, range, or table.

Arguments

Name	Dir	Type	Req	Default	Description
Range	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓

Properties

Name	Kind	Type
HasHeaders	property	`Boolean`
EmptyRowBehavior	property	`UiPath.Excel.EmptyRowBehavior`
SaveAfterEachRow	property	`Boolean`

Child Activities / Variable Scope

Name	Kind	Type	Description
Body	child	`ActivityAction<UiPath.Excel.CurrentRowQuickHandle, Int32>`

Excel Process Scope

UiPath.Excel.Activities.Business.ExcelProcessScopeX

Excel.Windows

Opens or reuses an Excel process. To be used in combination with the "Use Excel" activity to open Excel documents.

Properties

Name	Kind	Type
ProcessMode	property	`Nullable<UiPath.Excel.ExcelProcessMode>`
LaunchMethod	property	`Nullable<UiPath.Excel.ExcelStartMethod>`
LaunchTimeout	property	`Nullable<Int32>`
FileConflictResolution	property	`Nullable<UiPath.Excel.ExcelFileConflictResolution>`
ExistingProcessAction	property	`Nullable<UiPath.Excel.ExistingExcelProcessAction>`
DisplayAlerts	property	`Nullable<Boolean>`
ShowExcelWindow	property	`Nullable<Boolean>`
MacroSettings	property	`Nullable<UiPath.Excel.MacroSetting>`

Child Activities / Variable Scope

Name	Kind	Type	Description
Body	child	`ActivityAction<UiPath.Excel.IExcelProcess>`

Run Spreadsheet Macro

UiPath.Excel.Activities.Business.ExecuteMacroX

Excel.Windows.Workbook

Executes a specified macro within a macro-enabled workbook.

Arguments

Name	Dir	Type	Req
Workbook	In	`InArgument<UiPath.Excel.IWorkbookQuickHandle>`	✓
MacroName	In	`InArgument<String>`	✓
Result	Out	`OutArgument`

Child Activities / Variable Scope

Name	Kind	Type	Description
Body	child	`ActivityAction`

Macro Argument

UiPath.Excel.Activities.Business.ExecuteMacroArgumentX

Add an argument to use when executing the macro.

Arguments

Name	Dir	Type	Req	Default	Description
ArgumentValue	In	`InArgument<Object>`	✓

Export to CSV

UiPath.Excel.Activities.Business.ExportExcelToCsvX

Excel.Windows.Range

Exports the specified range, table, pivotTable or sheet to a CSV file.

Arguments

Name	Dir	Type	Req	Default	Description
FilePath	In	`InArgument<String>`	✓
TargetRange	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓

Fill Range

UiPath.Excel.Activities.Business.FillRangeX

Excel.Windows.Range

Enters a formula or value in all the cells in a range.

Arguments

Name	Dir	Type	Req	Default	Description
DestinationRange	In	`InArgument<UiPath.Excel.IWellDefinedReadWriteRangeRef>`	✓
Value	In	`InArgument<Object>`	✓

Filter Pivot Table

UiPath.Excel.Activities.Business.FilterPivotTableX

Excel.Windows.Pivot Table

Creates a filter in a pivot table based on the values in a single column. Can also be used to clear existing filters.

Arguments

Name	Dir	Type	Req	Default	Description
Table	In	`InArgument<UiPath.Excel.IPivotTableRef>`	✓
ColumnName	In	`InArgument<String>`

Properties

Name	Kind	Type	Description
ClearFilter	property	`Boolean`

Filter

UiPath.Excel.Activities.Business.FilterX

Excel.Windows.Range

Creates a filter in a range, table, or sheet based on the values in a single column. Can also be used to clear existing filters.

Arguments

Name	Dir	Type	Req	Default	Description
Range	In	`InArgument<UiPath.Excel.IReadWriteRangeRef>`	✓
ColumnName	In	`InArgument<String>`

Properties

Name	Kind	Type	Description
ClearFilter	property	`Boolean`

Find First/Last Data Row

UiPath.Excel.Activities.Business.FindFirstLastDataRowX

Excel.Windows.Range

Finds the first and the last rows containing data in a given sheet, range or table.

Arguments

Name	Dir	Type	Req
Range	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓
ColumnName	In	`InArgument<String>`	✓
FirstRowIndex	Out	`OutArgument<Int32>`
LastRowIndex	Out	`OutArgument<Int32>`

Properties

Name	Kind	Type
FirstRowOffset	property	`Int32`
LastRowOffset	property	`Int32`
BlankRowsToSkip	property	`Int32`
HasHeaders	property	`Boolean`
ConfigureLastRowAs	property	`UiPath.Excel.LastRowConfiguration`
VisibleRowsOnly	property	`Boolean`

Find/Replace Value

UiPath.Excel.Activities.Business.FindReplaceValueX

Excel.Windows.Range

Searches in a specified range for a certain value. Depending on the Operation chosen, it either returns the location of the cell or it replaces the value(s) with another given value.

Arguments

Name	Dir	Type	Req
WhereToSearch	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓
ValueToFind	In	`InArgument<Object>`	✓
ReplaceWith	In	`InArgument<Object>`
FoundAt	Out	`OutArgument<String>`

Properties

Name	Kind	Type
Operation	property	`UiPath.Excel.FindReplaceOptions`
LookIn	property	`UiPath.Excel.LookInOptions`
MatchCase	property	`Boolean`
MatchEntireCellContents	property	`Boolean`

For Each Excel Sheet

UiPath.Excel.Activities.Business.ForEachSheetX

Excel.Windows.Workbook

Repeats actions for each sheet in an Excel workbook.

Arguments

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.IWorkbookQuickHandle>`	✓

Child Activities / Variable Scope

Name	Kind	Type	Description
Body	child	`ActivityAction<UiPath.Excel.WorksheetQuickHandle, Int32>`

Format Cells

UiPath.Excel.Activities.Business.FormatRangeX

Excel.Windows.Range

Sets the format for all the cells in a specified range.

Arguments

Name	Dir	Type	Req	Default	Description
Range	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓

Get Excel Sensitivity Label

UiPath.Excel.Activities.Business.GetSensitivityLabelX

Excel.Windows.Workbook

Retrieves the sensitivity label from an Excel file

Arguments

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.IWorkbookQuickHandle>`	✓
SensitivityLabel	Out	`OutArgument<UiPath.Excel.IExcelLabelObject>`

Insert Column

UiPath.Excel.Activities.Business.InsertColumnX

Excel.Windows.Range

Inserts a column in a sheet, table, or range at the specified location.

Arguments

Name	Dir	Type	Req
Range	In	`InArgument<UiPath.Excel.IReadWriteRangeRef>`	✓
RelativeColumnName	In	`InArgument<String>`	✓
NewColumnName	In	`InArgument<String>`

Properties

Name	Kind	Type	Description
RelativePosition	property	`UiPath.Excel.ColumnRelativePosition`
HasHeaders	property	`Boolean`

Insert Chart

UiPath.Excel.Activities.Business.InsertExcelChartX

Excel.Windows.Chart

Create a chart in an Excel file.

Arguments

Name	Dir	Type	Req
Range	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓
InsertIntoSheet	In	`InArgument<UiPath.Excel.ISheetRef>`	✓
ChartHeight	In	`InArgument<Int32>`	✓
ChartWidth	In	`InArgument<Int32>`	✓
Left	In	`InArgument<Int32>`	✓
Top	In	`InArgument<Int32>`	✓
InsertedChart	Out	`OutArgument<UiPath.Excel.IChartRef>`

Properties

Name	Kind	Type	Description
ChartCategory	property	`UiPath.Excel.ExcelChartCategory`
ChartType	property	`UiPath.Excel.ExcelChartType`

Insert Rows

UiPath.Excel.Activities.Business.InsertRowsX

Excel.Windows.Range

Inserts one or more rows in a table, range, or sheet at the specified location.

Arguments

Name	Dir	Type	Req
Range	In	`InArgument<UiPath.Excel.IReadWriteRangeRef>`	✓
NbOfRows	In	`InArgument<Int32>`	✓
SpecificIndex	In	`InArgument<Int32>`

Properties

Name	Kind	Type	Description
InsertPosition	property	`UiPath.Excel.InsertRowPosition`
HasHeaders	property	`Boolean`

Insert Sheet

UiPath.Excel.Activities.Business.InsertSheetX

Excel.Windows.Workbook

Inserts a sheet in an Excel file.

Arguments

Name	Dir	Type	Req
Workbook	In	`InArgument<UiPath.Excel.IWorkbookQuickHandle>`	✓
Name	In	`InArgument<String>`	✓
ReferenceNewSheetAs	Out	`OutArgument<UiPath.Excel.ISheetRef>`

Invoke VBA

UiPath.Excel.Activities.Business.InvokeVBAX

Excel.Windows.Workbook

Invokes a macro from an external file containing VBA code and runs it against an Excel file.

Arguments

Name	Dir	Type	Req	Default
Workbook	In	`InArgument<UiPath.Excel.IWorkbookQuickHandle>`	✓
EntryMethodName	In	`InArgument<String>`	✓	`Main`
CodeFilePath	In	`InArgument<String>`	✓
Result	Out	`OutArgument`

Child Activities / Variable Scope

Name	Kind	Type	Description
Body	child	`ActivityAction`

VBA Argument

UiPath.Excel.Activities.Business.InvokeVBAArgumentX

The value to be passed to the Input argument of the VBA Sub/Function..

Arguments

Name	Dir	Type	Req	Default	Description
ArgumentValue	In	`InArgument<Object>`	✓

Lookup Range

UiPath.Excel.Activities.Business.LookupX

Excel.Windows.Range

Finds data in a range or sheet using Excel's LOOKUP function.

Arguments

Name	Dir	Type	Req
SourceRange	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓
ResultRange	In	`InArgument<UiPath.Excel.IReadRangeRef>`
Label	In	`InArgument<Object>`	✓
Value	Out	`OutArgument`

Match function

UiPath.Excel.Activities.Business.MatchFunctionX

Excel.Windows.Range

Searches for a specified item in a range of cells, and then returns the relative position of that item in the range.

Arguments

Name	Dir	Type	Req
ValueToMatch	In	`InArgument<Object>`	✓
InRange	In	`InArgument<UiPath.Excel.IWellDefinedReadRangeRef>`	✓
SaveTo	Out	`OutArgument<Int32>`

Properties

Name	Kind	Type	Description
MatchFunctionType	property	`UiPath.Excel.MatchType`

Pivot Field

UiPath.Excel.Activities.Business.PivotTableFieldX

Formats a range of cells as a table with a specified name.

Arguments

Name	Dir	Type	Req	Default	Description
FieldName	In	`InArgument<String>`	✓

Properties

Name	Kind	Type	Description
Type	property	`UiPath.Excel.Activities.Business.PivotTableFieldType`
Function	property	`UiPath.Excel.PivotTableFunction`

Protect Sheet

UiPath.Excel.Activities.Business.ProtectSheetX

Excel.Windows.Workbook

Protects a sheet in an Excel workbook.

Arguments

Name	Dir	Type	Req
Sheet	In	`InArgument<UiPath.Excel.ISheetRef>`	✓
Password	In	`InArgument<String>`
SecurePassword	In	`InArgument<Security.SecureString>`

Properties

Name	Kind	Type	Description
AdditionalPermissions	property	`UiPath.Excel.ProtectSheetAdditionalPermissions`

Read Cell Formula

UiPath.Excel.Activities.Business.ReadCellFormulaX

Excel.Windows.Cell

Reads the formula from a spreadsheet cell.

Arguments

Name	Dir	Type	Req	Default	Description
Cell	In	`InArgument<UiPath.Excel.IReadCellRef>`	✓
SaveTo	Out	`OutArgument<String>`

Read Cell Value

UiPath.Excel.Activities.Business.ReadCellValueX

Excel.Windows.Cell

Reads the value from a spreadsheet cell.

Arguments

Name	Dir	Type	Req	Default	Description
Cell	In	`InArgument<UiPath.Excel.IReadCellRef>`	✓
SaveTo	Out	`OutArgument`

Properties

Name	Kind	Type	Description
GetFormattedText	property	`Boolean`

Read Range

UiPath.Excel.Activities.Business.ReadRangeX

Excel.Windows.Range

Reads the value of an Excel range as a DataTable.

Arguments

Name	Dir	Type	Req	Default	Description
Range	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓
SaveTo	Out	`OutArgument<Data.DataTable>`

Properties

Name	Kind	Type
ReadFormatting	property	`Nullable<UiPath.Excel.ReadFormattingOptions>`
HasHeaders	property	`Boolean`
VisibleOnly	property	`Boolean`

Refresh Excel Data Connections

UiPath.Excel.Activities.Business.RefreshDataConnectionsX

Excel.Windows.Workbook

Get the latest data by refreshing all sources in the workbook.

Arguments

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.IWorkbookQuickHandle>`	✓

Refresh Pivot Table

UiPath.Excel.Activities.Business.RefreshPivotTableX

Excel.Windows.Pivot Table

Updates the data for a pivot table.

Arguments

Name	Dir	Type	Req	Default	Description
Table	In	`InArgument<UiPath.Excel.IPivotTableRef>`	✓

Properties

Name	Kind	Type	Description
LayoutRowType	property	`Nullable<UiPath.Excel.PivotTableLayoutRowType>`

Remove Duplicates

UiPath.Excel.Activities.Business.RemoveDuplicatesX

Excel.Windows.Range

Delete duplicate rows

Arguments

Name	Dir	Type	Req	Default	Description
Range	In	`InArgument<UiPath.Excel.IReadWriteRangeRef>`	✓

Properties

Name	Kind	Type	Description
HasHeaders	property	`Boolean`
ColumnsCompareMode	property	`UiPath.Excel.ColumnsCompare`

Rename Sheet

UiPath.Excel.Activities.Business.RenameSheetX

Excel.Windows.Workbook

Renames a sheet in an Excel file.

Arguments

Name	Dir	Type	Req	Default	Description
From	In	`InArgument<UiPath.Excel.ISheetRef>`	✓
To	In	`InArgument<String>`	✓

Save Excel File As PDF

UiPath.Excel.Activities.Business.SaveAsPdfX

Excel.Windows.Workbook

Saves an Excel file as a PDF file.

Arguments

Name	Dir	Type	Req
Workbook	In	`InArgument<UiPath.Excel.IWorkbookQuickHandle>`	✓
DestinationPdfPath	In	`InArgument<String>`	✓
StartPage	In	`InArgument<Nullable<Int32>>`
EndPage	In	`InArgument<Nullable<Int32>>`

Properties

Name	Kind	Type	Description
SaveQuality	property	`UiPath.Excel.PdfSaveQuality`
ReplaceExisting	property	`Boolean`

Save Excel File As

UiPath.Excel.Activities.Business.SaveExcelFileAsX

Excel.Windows.Workbook

Save an Excel file as a different file.

Arguments

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.IWorkbookQuickHandle>`	✓
FilePath	In	`InArgument<String>`	✓

Properties

Name	Kind	Type	Description
SaveAsFileType	property	`UiPath.Excel.ExcelSaveAsType`
ReplaceExisting	property	`Boolean`

Save Excel File

UiPath.Excel.Activities.Business.SaveExcelFileX

Excel.Windows.Workbook

Saves any pending changes in the selected Excel file.

Arguments

Name	Dir	Type	Req	Default	Description
Workbook	In	`InArgument<UiPath.Excel.IWorkbookQuickHandle>`	✓

Single Excel Process Scope

UiPath.Excel.Activities.Business.SequenceX

Excel.Windows

Use this activity as root of your Attended Workflow to enforce that at most one Excel process exists at start of execution. This behavior ensures all the Excel documents are open in the same Excel process and will make your workflow more stable and faster. This activity is used as root for StudioX workflows.

Child Activities / Variable Scope

Name	Kind	Type	Description
Activities	child	`Collection<Activity>`

Sort By Column

UiPath.Excel.Activities.Business.SortColumnX

Excel.Windows

Sorts the range by the column in the indicated direction.

Arguments

Name	Dir	Type	Req	Default	Description
ColumnName	In	`InArgument<String>`	✓

Properties

Name	Kind	Type	Description
SortDirection	property	`UiPath.Excel.Activities.Business.SortDirectionType`

Sort Range

UiPath.Excel.Activities.Business.SortX

Excel.Windows.Range

Sorts the data in a specified sheet, table, or range by one or more columns.

Arguments

Name	Dir	Type	Req	Default	Description
Range	In	`InArgument<UiPath.Excel.IReadWriteRangeRef>`	✓

Child Activities / Variable Scope

Name	Kind	Type	Description
Body	child	`ActivityAction`

Text to Columns

UiPath.Excel.Activities.Business.TextToColumnsX

Excel.Windows.Range

Splits the text from a cell, range, or table into different columns.

Arguments

Name	Dir	Type	Req
SourceRange	In	`InArgument<UiPath.Excel.IWellDefinedReadRangeRef>`	✓
DestinationRange	In	`InArgument<UiPath.Excel.IReadWriteRangeRef>`	✓
NumberOfCharactersPerColumn	In	`InArgument<Int32>`

Properties

Name	Kind	Type
ParsingType	property	`UiPath.Excel.TextToColumnsParsingType`
SplitByTabs	property	`Boolean`
SplitBySemicolon	property	`Boolean`
SplitByComma	property	`Boolean`
SplitBySpace	property	`Boolean`
SplitByLineBreak	property	`Boolean`
SplitByOther	property	`Boolean`
OtherSeparator	property	`Nullable<Char>`
ConsecutiveOperatorsAsOne	property	`Boolean`
TextQualifier	property	`UiPath.Excel.TextToColumnsTextQualifier`

Unprotect Sheet

UiPath.Excel.Activities.Business.UnprotectSheetX

Excel.Windows.Workbook

Unprotects a sheet in an Excel workbook.

Arguments

Name	Dir	Type	Req
Sheet	In	`InArgument<UiPath.Excel.ISheetRef>`	✓
Password	In	`InArgument<String>`
SecurePassword	In	`InArgument<Security.SecureString>`

Update Chart

UiPath.Excel.Activities.Business.UpdateChartX

Excel.Windows.Chart

Update properties of an existing Excel chart.

Arguments

Name	Dir	Type	Req	Default	Description
Chart	In	`InArgument<UiPath.Excel.IChartRef>`	✓

Child Activities / Variable Scope

Name	Kind	Type	Description
Body	child	`ActivityAction`

VLookup

UiPath.Excel.Activities.Business.VLookupX

Excel.Windows.Range

Finds data in a range or sheet using Excel's VLOOKUP function.

Arguments

Name	Dir	Type	Req
SourceRange	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓
Label	In	`InArgument<Object>`	✓
ColumnIndex	In	`InArgument<Int32>`
Value	Out	`OutArgument`

Properties

Name	Kind	Type	Description
ExactMatch	property	`Boolean`

Write Cell

UiPath.Excel.Activities.Business.WriteCellX

Excel.Windows.Cell

Enters a text or a formula in a cell.

Arguments

Name	Dir	Type	Req	Default	Description
Cell	In	`InArgument<UiPath.Excel.IReadWriteCellRef>`	✓
Value	In	`InArgument<Object>`	✓

Properties

Name	Kind	Type	Description
AutoIncrementRow	property	`Boolean`

Write DataTable to Excel

UiPath.Excel.Activities.Business.WriteRangeX

Excel.Windows.Range

Write Range is intended for writing data from external Data Table sources into Excel.

Arguments

Name	Dir	Type	Req	Default	Description
Source	In	`InArgument<Data.DataTable>`	✓
Destination	In	`InArgument<UiPath.Excel.IReadWriteRangeRef>`	✓

Properties

Name	Kind	Type
Append	property	`Boolean`
ExcludeHeaders	property	`Boolean`
IgnoreEmptySource	property	`Boolean`

Change Data Range

UiPath.Excel.Activities.Business.ChartModifications.ChangeDataRangeModification

Arguments

Name	Dir	Type	Req	Default	Description
Range	In	`InArgument<UiPath.Excel.IReadRangeRef>`	✓

Modify Chart Title

UiPath.Excel.Activities.Business.ChartModifications.ModifyChartTitleModification

Arguments

Name	Dir	Type	Req	Default	Description
Title	In	`InArgument<String>`

Properties

Name	Kind	Type	Description
ShowTitle	property	`Boolean`

Show/Hide Data Labels

UiPath.Excel.Activities.Business.ChartModifications.ShowHideDataLabelsModification

Properties

Name	Kind	Type	Description
ShowDataLabels	property	`Boolean`

Show/Hide Legend

UiPath.Excel.Activities.Business.ChartModifications.ShowHideLegendModification

Properties

Name	Kind	Type	Description
ShowLegend	property	`Boolean`

Update Axis Bounds

UiPath.Excel.Activities.Business.ChartModifications.UpdateAxisBoundsModification

Arguments

Name	Dir	Type	Req	Default	Description
MinBound	In	`InArgument<Double>`
MaxBound	In	`InArgument<Double>`

Properties

Name	Kind	Type	Description
Axis	property	`UiPath.Excel.Activities.Business.ChartModifications.AxisOrientation`

Update Axis Title

UiPath.Excel.Activities.Business.ChartModifications.UpdateAxisTitleModification

Arguments

Name	Dir	Type	Req	Default	Description
Title	In	`InArgument<String>`

Properties

Name	Kind	Type	Description
Axis	property	`UiPath.Excel.Activities.Business.ChartModifications.AxisOrientation`
ShowTitle	property	`Boolean`