Manage Worksheets of Microsoft Excel files.
Aspose.Cells provides a class, Workbook that represents an Excel file. The Workbook class contains a worksheets collection that allows access to each worksheet in the Excel file.
A worksheet is represented by the Worksheet class. The Worksheet class provides a wide range of properties and methods for managing worksheets.
How to Add Worksheets to a New Excel File
To create a new Excel file programmatically:
- Create an object of the Workbook class.
- Call the add method of the WorksheetCollection class. An empty worksheet is added to the Excel file automatically. It can be referenced by passing the sheet index of the new worksheet to the worksheets collection.
- Obtain a worksheet reference.
- Perform work on the worksheets.
- Save the new Excel file with new worksheets by calling the Workbook class' save method.
from aspose.cells import Workbook | |
from os import os, path | |
# For complete examples and data files, please go to https:# github.com/aspose-cells/Aspose.Cells-for-.NET | |
# The path to the documents directory. | |
dataDir = RunExamples.GetDataDir(".") | |
# Create directory if it is not already present. | |
IsExists = path.isdir(dataDir) | |
if notIsExists: | |
os.makedirs(dataDir) | |
# Instantiating a Workbook object | |
workbook = Workbook() | |
# Adding a new worksheet to the Workbook object | |
i = workbook.worksheets.add() | |
# Obtaining the reference of the newly added worksheet by passing its sheet index | |
worksheet = workbook.worksheets[i] | |
# Setting the name of the newly added worksheet | |
worksheet.name = "My Worksheet" | |
# Saving the Excel file | |
workbook.save(dataDir + "output.out.xls") |
How to Add Worksheets to a Designer Spreadsheet
The process of adding worksheets to a designer spreadsheet is the same as that of adding a new worksheet, except that the Excel file already exists so should be opened before worksheets are added. A designer spreadsheet can be opened by the Workbook class.
from aspose.cells import Workbook | |
# For complete examples and data files, please go to https:# github.com/aspose-cells/Aspose.Cells-for-.NET | |
# The path to the documents directory. | |
dataDir = RunExamples.GetDataDir(".") | |
InputPath = dataDir + "book1.xlsx" | |
# Creating a file stream containing the Excel file to be opened | |
fstream = open(InputPath, "rb") | |
# Opening the Excel file through the file stream | |
workbook = Workbook(fstream) | |
# Adding a new worksheet to the Workbook object | |
i = workbook.worksheets.add() | |
# Obtaining the reference of the newly added worksheet by passing its sheet index | |
worksheet = workbook.worksheets[i] | |
# Setting the name of the newly added worksheet | |
worksheet.name = "My Worksheet" | |
# Saving the Excel file | |
workbook.save(dataDir + "output.xlsx") |
How to Access Worksheets using Sheet Name
Access any worksheet by specifying its name or index.
from aspose.cells import Workbook | |
# For complete examples and data files, please go to https:# github.com/aspose-cells/Aspose.Cells-for-.NET | |
# The path to the documents directory. | |
dataDir = RunExamples.GetDataDir(".") | |
InputPath = dataDir + "book1.xlsx" | |
# Creating a file stream containing the Excel file to be opened | |
fstream = open(InputPath, "rb") | |
# Instantiating a Workbook object | |
# Opening the Excel file through the file stream | |
workbook = Workbook(fstream) | |
# Accessing a worksheet using its sheet name | |
worksheet = workbook.worksheets.get("Sheet1") | |
cell = worksheet.cells.get("A1") | |
print(cell.value) |
How to Remove Worksheets using Sheet Name
To remove worksheets from a file, call the remove_by_name method of WorksheetCollection class. Pass the sheet name to the remove_by_name method to remove a specific worksheet.
from aspose.cells import Workbook | |
# For complete examples and data files, please go to https:# github.com/aspose-cells/Aspose.Cells-for-.NET | |
# The path to the documents directory. | |
dataDir = RunExamples.GetDataDir(".") | |
# Creating a file stream containing the Excel file to be opened | |
fstream = open(dataDir + "book1.xls", "rb") | |
# Instantiating a Workbook object | |
# Opening the Excel file through the file stream | |
workbook = Workbook(fstream) | |
# Removing a worksheet using its sheet name | |
workbook.worksheets.remove_by_name("Sheet1") | |
# Save workbook | |
workbook.save(dataDir + "output.out.xls") |
How to Remove Worksheets using Sheet Index
Removing worksheets by name works well when the name of the worksheet is known. If you don’t know the worksheet’s name, use the remove_by_index method that takes the sheet index of the worksheet instead of its sheet name.
from aspose.cells import Workbook | |
# For complete examples and data files, please go to https:# github.com/aspose-cells/Aspose.Cells-for-.NET | |
# The path to the documents directory. | |
dataDir = RunExamples.GetDataDir(".") | |
# Creating a file stream containing the Excel file to be opened | |
fstream = open(dataDir + "book1.xls", "rb") | |
# Instantiating a Workbook object | |
# Opening the Excel file through the file stream | |
workbook = Workbook(fstream) | |
# Removing a worksheet using its sheet index | |
workbook.worksheets.remove_by_index(0) | |
# Save workbook | |
workbook.save(dataDir + "output.out.xls") |
How to Activate Sheets and Make an Active Cell in the Worksheet
Sometimes, you need a specific worksheet to be active and displayed when a user opens a Microsoft Excel file in Excel. Similarly, you might want to activate a specific cell and set the scrollbars to show the active cell. Aspose.Cells is capable of doing all these tasks.
An active sheet is a sheet you’re working on: the active sheet’s name on the tab is bold by default.
An active cell is a selected cell, the cell into which data is entered when you begin typing. Only one cell is active at a time. The active cell is highlighted by a heavy border.
How to Activate Sheets and Make a Cell Active
Aspose.Cells provides specific API calls for activating a sheet and a cell. For Example, the Aspose.Cells.WorksheetCollection.active_sheet_index property is useful for setting the active sheet in a workbook. Similarly, Aspose.Cells.Worksheet.active_cell property is used to set and get an active cell in the worksheet.
To make sure that the horizontal or vertical scrollbars are at the row and column index position you want to show specific data, use the Aspose.Cells.Worksheet.first_visible_row and Aspose.Cells.Worksheet.first_visible_column properties.
The following example shows how to activate a worksheet and make an active cell in it. In the generated output, the scrollbars will be scrolled to make the 2nd row and 2nd column as their first visible row and column.
from aspose.cells import Workbook | |
# For complete examples and data files, please go to https:# github.com/aspose-cells/Aspose.Cells-for-.NET | |
# The path to the documents directory. | |
dataDir = RunExamples.GetDataDir(".") | |
# Instantiate a new Workbook. | |
workbook = Workbook() | |
# Get the first worksheet in the workbook. | |
worksheet1 = workbook.worksheets[0] | |
# Get the cells in the worksheet. | |
cells = worksheet1.cells | |
# Input data into B2 cell. | |
cells.get(1, 1).put_value("Hello World!") | |
# Set the first sheet as an active sheet. | |
workbook.worksheets.active_sheet_index = 0 | |
# Set B2 cell as an active cell in the worksheet. | |
worksheet1.active_cell = "B2" | |
# Set the B column as the first visible column in the worksheet. | |
worksheet1.first_visible_column = 1 | |
# Set the 2nd row as the first visible row in the worksheet. | |
worksheet1.first_visible_row = 1 | |
# Save the excel file. | |
workbook.save(dataDir + "output.xls") |