RPA.Excel.Application

Add new worksheet to workbook. Workbook is created by default if it does not exist.

Arguments

ArgumentTypeDefault valueDescription
sheetnamestrnullname for sheet
create_workbookboolTruecreate workbook if True, defaults to True
param sheetname:
 name for sheet
param create_workbook:
 create workbook if True, defaults to True
raises ValueError:
 error is raised if workbook does not exist and create_workbook is False

Adds new workbook for Excel application

Close the active document and app (if open).

Arguments

ArgumentTypeDefault valueDescription
save_changesboolFalseEnable changes saving on quit. (False by default)
param save_changes:
 Enable changes saving on quit. (False by default)

Export Excel as PDF file

Arguments

ArgumentTypeDefault valueDescription
pdf_filenamestrnullPDF filename to save
excel_filenamestr, NoneNoneExcel filename to open

If Excel filename is not given, the currently open workbook will be exported as PDF.

param pdf_filename:
 PDF filename to save
param excel_filename:
 Excel filename to open

Find first available free cell

Arguments

ArgumentTypeDefault valueDescription
worksheetAnyNoneworksheet to handle, defaults to active worksheet if None
rowint1starting row for search, defaults to 1
columnint1starting column for search, defaults to 1
param worksheet:
 worksheet to handle, defaults to active worksheet if None
param row:starting row for search, defaults to 1
param column:starting column for search, defaults to 1
return:tuple (row, column) or (None, None) if not found

Find first available free row

Arguments

ArgumentTypeDefault valueDescription
worksheetAny, NoneNoneworksheet to handle, defaults to active worksheet if None
rowint1starting row for search, defaults to 1
columnint1starting column for search, defaults to 1
param worksheet:
 worksheet to handle, defaults to active worksheet if None
param row:starting row for search, defaults to 1
param column:starting column for search, defaults to 1
return:row or None

Open the application.

Arguments

ArgumentTypeDefault valueDescription
visibleboolFalseShow the window on opening. (False by default)
display_alertsboolFalseDisplay alert popups. (False by default)
param visible:Show the window on opening. (False by default)
param display_alerts:
 Display alert popups. (False by default)

Open Excel by filename

Arguments

ArgumentTypeDefault valueDescription
filenamestrnullpath to filename

By default sets active worksheet to sheet number 1

param filename:path to filename

Quit the application.

Arguments

ArgumentTypeDefault valueDescription
save_changesboolFalseEnable to save changes on quit. (False by default)
param save_changes:
 Enable to save changes on quit. (False by default)

Read value from cell.

Arguments

ArgumentTypeDefault valueDescription
worksheetAnyNoneworksheet to handle, defaults to active worksheet if None
rowintNonetarget row, defaults to None
columnintNonetarget row, defaults to None
param worksheet:
 worksheet to handle, defaults to active worksheet if None
param row:target row, defaults to None
param column:target row, defaults to None
raises ValueError:
 if cell is not given

Run Excel macro with given name

Arguments

ArgumentTypeDefault valueDescription
macro_namestrnullmacro to run
argsAnynullarguments to pass to macro
param macro_name:
 macro to run
param args:arguments to pass to macro

Saves Excel file

Save Excel with name if workbook is open

Arguments

ArgumentTypeDefault valueDescription
filenamestrnullwhere to save file
autofitboolFalseautofit cell widths if True, defaults to False
file_formatNoneformat of file
param filename:where to save file
param autofit:autofit cell widths if True, defaults to False
param file_format:
 format of file

Note: Changing the file extension for the path does not affect the actual format. To use an older format, use the file_format argument with one of the following values:

https://docs.microsoft.com/en-us/office/vba/api/excel.xlfileformat

Examples:

# Save workbook in modern format Save excel as orders.xlsx # Save workbook in Excel 97 format (format from above URL) Save excel as legacy.xls file_format=${56}

Set active worksheet by either its sheet number or name

Arguments

ArgumentTypeDefault valueDescription
sheetnamestrNonename of Excel sheet, defaults to None
sheetnumberintNoneindex of Excel sheet, defaults to None
param sheetname:
 name of Excel sheet, defaults to None
param sheetnumber:
 index of Excel sheet, defaults to None

Write value, number_format and/or formula into cell.

Arguments

ArgumentTypeDefault valueDescription
worksheetAnyNoneworksheet to handle, defaults to active worksheet if None
rowintNonetarget row, defaults to None
columnintNonetarget row, defaults to None
valuestrNonepossible value to set, defaults to None
number_formatstrNonepossible number format to set, defaults to None
formulastrNonepossible format to set, defaults to None
param worksheet:
 worksheet to handle, defaults to active worksheet if None
param row:target row, defaults to None
param column:target row, defaults to None
param value:possible value to set, defaults to None
param number_format:
 possible number format to set, defaults to None
param formula:possible format to set, defaults to None
raises ValueError:
 if cell is not given