Item(String) Property

Returns the specified worksheet.

Syntax

Visual Basic
C#

'Declaration
 
Overloads ReadOnly Property Item( _
   ByVal name As System.String _
) As IWorksheet

'Usage
 
Dim instance As IWorksheets
Dim name As System.String
Dim value As IWorksheet
 
value = instance.Item(name)

IWorksheet Item( 
   System.string name
) {get;}

Parameters

name: The name of the worksheet to return.

Example

class Program
{
    static void Main()
    {
        // Create a new empty workbook set.
        SpreadsheetGear.IWorkbookSet workbookSet = SpreadsheetGear.Factory.GetWorkbookSet();
        // Create a new empty workbook in the workbook set.
        SpreadsheetGear.IWorkbook workbook = workbookSet.Workbooks.Add();
        // Add a second worksheet.
        workbook.Worksheets.Add();
        // Rename worksheet "Sheet1" to "Hello"
        workbook.Worksheets["Sheet1"].Name = "Hello";
        // Rename worksheet "Sheet2" to "World"
        workbook.Worksheets["Sheet2"].Name = "World";
        // Save to C:\MyData.xls.
        workbook.SaveAs("C:\\MyData.xls", SpreadsheetGear.FileFormat.Excel8);
        // Close the workbook, removing it from the workbook set.
        workbookSet.Workbooks.Close();
        // Open the saved workbook from memory.
        workbook = workbookSet.Workbooks.Open("C:\\MyData.xls");
        // Output the sheet names separated by a space ("Hello World").
        System.Console.WriteLine(workbook.Worksheets[0].Name + " " + workbook.Worksheets[1].Name);
    }
}

Visual Basic

Class Program
    Shared Sub Main()
        ' Create a new empty workbook set.
        Dim workbookSet As SpreadsheetGear.IWorkbookSet = SpreadsheetGear.Factory.GetWorkbookSet()
        ' Create a new empty workbook in the workbook set.
        Dim workbook As SpreadsheetGear.IWorkbook = workbookSet.Workbooks.Add()
        ' Add a second worksheet.
        workbook.Worksheets.Add()
        ' Rename worksheet "Sheet1" to "Hello"
        workbook.Worksheets("Sheet1").Name = "Hello"
        ' Rename worksheet "Sheet2" to "World"
        workbook.Worksheets("Sheet2").Name = "World"
        ' Save to C:\MyData.xls.
        workbook.SaveAs("C:\MyData.xls", SpreadsheetGear.FileFormat.Excel8)
        ' Close the workbook, removing it from the workbook set.
        workbookSet.Workbooks.Close()
        ' Open the saved workbook from memory.
        workbook = workbookSet.Workbooks.Open("C:\MyData.xls")
        ' Output the sheet names separated by a space ("Hello World").
        System.Console.WriteLine((workbook.Worksheets(0).Name + " " + workbook.Worksheets(1).Name))
    End Sub 'Main
End Class 'Program

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

IWorksheets Interface
IWorksheets Members
Overload List

See our live ASP.NET Excel Reporting, Excel Charting, Dashboards from Charts and Ranges, Excel Calculation and Excel to DataGrid Samples.

Copyright © 2003-2023 SpreadsheetGear LLC. All Rights Reserved.
SpreadsheetGear® is a registered trademark and Spreadsheet Gear is a trademark of SpreadsheetGear LLC.
Microsoft, Microsoft Excel, Visual Studio and the Visual Studio logo are trademarks or registered trademarks of Microsoft Corporation in the United States and/or other countries.

Send Feedback