Add New Sheet

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

Arguments

Argument Type Default value Description
sheetnamestrnullname for sheet
tabnamestr, NoneNonename for tab (deprecated)
create_workbookboolTruecreate workbook if True, defaults to True
param sheetname:
 name for sheet
param tabname:name for tab (deprecated)
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

Add New Workbook

Adds new workbook for Excel application

Close Document

Close the active document (if open).

Arguments

Argument Type Default value Description
save_changesboolFalse

Export As Pdf

Export Excel as PDF file

Arguments

Argument Type Default value Description
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 Cell

Find first available free cell

Arguments

Argument Type Default value Description
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:tuple (row, column) or (None, None) if not found

Find First Available Row

Find first available free row

Arguments

Argument Type Default value Description
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 Application

Open the Excel application.

Arguments

Argument Type Default value Description
visibleboolFalseshow window after opening
display_alertsboolFalseshow alert popups
param visible:show window after opening
param display_alerts:
 show alert popups

Open Workbook

Open Excel by filename

Arguments

Argument Type Default value Description
filenamestrnullpath to filename

By default sets active worksheet to sheet number 1

param filename:path to filename

Quit Application

Quit the application.

Arguments

Argument Type Default value Description
save_changesboolFalse

Read From Cells

Read value from cell.

Arguments

Argument Type Default value Description
worksheetAny, NoneNoneworksheet to handle, defaults to active worksheet if None
rowint, NoneNonetarget row, defaults to None
columnint, NoneNonetarget 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 Macro

Run Excel macro with given name

Arguments

Argument Type Default value Description
macro_namestrnullmacro to run
argsAnynullarguments to pass to macro
param macro_name:
 macro to run
param args:arguments to pass to macro

Save Excel

Saves Excel file

Save Excel As

Save Excel with name if workbook is open

Arguments

Argument Type Default value Description
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

Set active worksheet by either its sheet number or name

Arguments

Argument Type Default value Description
sheetnamestr, NoneNonename of Excel sheet, defaults to None
sheetnumberint, NoneNoneindex 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 To Cells

Write value, number_format and/or formula into cell.

Arguments

Argument Type Default value Description
worksheetAny, NoneNoneworksheet to handle, defaults to active worksheet if None
rowint, NoneNonetarget row, defaults to None
columnint, NoneNonetarget row, defaults to None
valuestr, NoneNonepossible value to set, defaults to None
number_formatstr, NoneNonepossible number format to set, defaults to None
formulastr, NoneNonepossible 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