RPA.Excel.Files

The content argument can be of any tabular format. Typically this is a Table object created by the RPA.Tables library, but it can also be a list of lists, or a list of dictionaries.

If the header flag is enabled, the existing header in the worksheet is used to insert values in the correct columns. This assumes that that source data has this data available.

If the header is not on the first row of the worksheet, the start argument can be used to give the correct row index.

Examples:

*** Tasks ***
# Append an existing Table object
Open workbook    orders.xls
Append rows to worksheet    ${table}

# Append to a worksheet with headers on row 5
Open workbook    customers.xlsx
Append rows to worksheet    ${table}    header=${TRUE}   start=5

Automatically also creates a new worksheet with the name "Sheet".

Examples:

*** Tasks ***
# Create modern format workbook
Create workbook    fmt=xlsx
Save workbook    orders.xlsx

# Create legacy format workbook
Create workbook    fmt=xls
Save workbook    orders.xls

Examples:

*** Tasks ***
Open workbook       customers.xlsx
Create worksheet    Orders

Find the first empty row after existing content, and return the row number.

Examples:

*** Tasks ***
Append rows to worksheet     ${rows}
${next}=    Find empty row
Insert image to worksheet    ${next}    A    screenshot.png

Examples:

*** Tasks ***
# Read header names
${column1}=    Get cell value    1    A
${column2}=    Get cell value    1    B
${column3}=    Get cell value    1    C

Alias for keyword Get cell value, see the original keyword for documentation.

The path argument should be a local file path to the image file.

By default the image is inserted in the original size, but it can be scaled with the scale argument. It's scaled with a factor where the value 1.0 is the default.

Examples:

*** Tasks ***
Create worksheet    Order
Append rows to worksheet     ${details}
${last_row}=    Find empty row
Insert image to worksheet    ${last_row}    A    screenshot.png

Opens the workbook in memory and sets it as the active workbook. This library can only have one workbook open at a time, and any previously opened workbooks are closed first.

The file can be in either .xlsx or .xlsx format.

Examples:

*** Tasks ***
Open workbook    path/to/file.xlsx
${table}=    Read worksheet as table

Each key in the dictionary will be either values from the header row, or Excel-style column letters.

Examples:

*** Tasks ***
Open Workbook   orders.xlsx
${rows}=        Read Worksheet     header=True
Close Workbook

Read the content of a worksheet into a Table container. Allows sorting/filtering/manipulating using the RPA.Tables library.

Examples:

*** Tasks ***
Open Workbook   orders.xlsx
${table}=       Read Worksheet As Table     header=True
Close Workbook

Examples:

*** Tasks ***
# Remove last worksheet
Open workbook    orders.xlsx
${sheets}=       List worksheets
Remove worksheet    ${sheets}[-1]

Examples:

*** Tasks ***
Create workbook
Rename worksheet    Sheet    Orders

Note: No changes to the workbook are saved to the actual file unless this keyword is called.

This keyword can be used to set the default worksheet for keywords, which removes the need to specify the worksheet name for each keyword. It can always be overridden on a per-keyword basis.

Examples:

*** Tasks ***
Open workbook    complex.xlsx
Set active worksheet    Customers
Append rows to worksheet    ${rows}

Does not affect the values themselves, but changes how the values are displayed when opening with an external application such as Microsoft Excel or LibreOffice Calc.

The fmt argument accepts all format code values that are supported by the aforementioned applications.

Some examples of valid values:

Examples:

*** Tasks ***
# Set value to have one decimal precision
Set cell value    2  B    ${value}
Set cell format   2  B    00.0

Examples:

*** Tasks ***
# Set a value in the first row and column
Set cell value    1    1    Some value
Set cell value    1    A    Some value

# Set a value with cell formatting
Set cell value    2    B    ${value}    fmt=0%

Alias for keyword Set cell value, see the original keyword for documentation.