Introduction
An Excel file can have one or more than one worksheets. Whenever we create an Excel file, we add worksheets to the Excel file in which we work. Each worksheet in an Excel file is independent from the other worksheet by having its own data and formatting settings etc. Sometimes, developers may require to make few worksheets hidden and others visible in the Excel file for their own interest. So, Aspose.Cells allows developers to control the visibility of the worksheets in their Excel files.
Controlling the Visibility of the Worksheets
Aspose.Cells provides a class, Workbook that represents an Excel file. Workbook class contains a Worksheets collection that allows to access each worksheet in the Excel file.
A worksheet is represented by the Worksheet class. Worksheet class provides a wide range of properties and methods to manage a worksheet. But, to control the visibility of a worksheet, developers may use IsVisible property of the Worksheet class. IsVisible is a boolean property, which means that it can only store a true or false value.
Hiding a Worksheet
Developers can hide a worksheet by setting the IsVisible property of the Worksheet class to false.
Example:
[C#]
//Hiding the worksheet of the Excel file
worksheet.IsVisible=false;
[VB.NET]
'Hiding the worksheet of the Excel file
worksheet.IsVisible=False
[JAVA]
//Hiding the worksheet of the Excel file
worksheet.setVisible(false);
Making a Worksheet Visible
Developers can make a worksheet visible by setting the IsVisible property of the Worksheet class to true.
Example:
[C#]
//Displaying the worksheet of the Excel file
worksheet.IsVisible=true;
[VB.NET]
'Displaying the worksheet of the Excel file
worksheet.IsVisible=True
[JAVA]
//Displaying the worksheet of the Excel file
worksheet.setVisible(true);
Example:
A complete example is given below that demonstrates the use of IsVisible property of Worksheet class to hide the first worksheet of the Excel file.
[C#]
//Instantiating a Workbook object
Workbook workbook = new Workbook();
//Creating a file stream containing the Excel file to be opened
FileStream fstream = new FileStream("C:\\book1.xls",FileMode.Open);
//Opening the Excel file through the file stream
workbook.Open(fstream);
//Accessing the first worksheet in the Excel file
Worksheet worksheet = workbook.Worksheets[0];
//Hiding the first worksheet of the Excel file
worksheet.IsVisible = false;
//Saving the modified Excel file in default (that is Excel 2000) format
workbook.Save("C:\\output.xls",FileFormatType.Default);
//Closing the file stream to free all resources
fstream.Close();
[VB.NET]
'Instantiating a Workbook object
Dim workbook As Workbook = New Workbook()
'Creating a file stream containing the Excel file to be opened
Dim fstream As FileStream = New FileStream("C:\\book1.xls",FileMode.Open)
'Opening the Excel file through the file stream
workbook.Open(fstream)
'Accessing the first worksheet in the Excel file
Dim worksheet As Worksheet = workbook.Worksheets(0)
'Hiding the first worksheet of the Excel file
worksheet.IsVisible = False
'Saving the modified Excel file in default (that is Excel 2000) format
workbook.Save("C:\\output.xls",FileFormatType.Default)
'Closing the file stream to free all resources
fstream.Close()
[JAVA]
//Instantiating a Workbook object
Workbook workbook = new Workbook();
//Opening the Excel file
workbook.open("C:\\book1.xls");
//Accessing the first worksheet in the Excel file
Worksheets worksheets = workbook.getWorksheets();
Worksheet worksheet = worksheets.getSheet(0);
//Hiding the first worksheet of the Excel file
worksheet.setVisible(false);
//Saving the modified Excel file in default (that is Excel 2000) format
workbook.save("C:\\output.xls");
Worksheet - Before Modification
In the screenshot below, you can see that Book1.xls file contains three worksheets: Sheet1, Sheet2 and Sheet3.
|
Figure: Worksheet view before any modification
|
Worksheet - After Executing the Example Code
Book1.xls file is opened by calling the Open method of Workbook class and then the first worksheet of the Book1.xls file is made hidden. The modified file is saved as output.xls file whose pictorial view is shown below:
|
Figure: Worksheet view after modification
|