Open(String) Method

Open an existing workbook in a newly created instance of IWorkbook.

Syntax

Visual Basic
C#

'Declaration
 
Overloads Function Open( _
   ByVal filename As System.String _
) As IWorkbook

'Usage
 
Dim instance As IWorkbooks
Dim filename As System.String
Dim value As IWorkbook
 
value = instance.Open(filename)

IWorkbook Open( 
   System.string filename
)

Parameters

filename: The filename of the workbook to open.

Return Value

The opened workbook.

Remarks

The various workbook settings which make a workbook read-only in an end user workbookSet have no affect at this level. These settings are available as IWorkbook properties.

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();
        // Save to C:\MyData.xls.
        workbook.SaveAs("C:\\MyData.xls", SpreadsheetGear.FileFormat.Excel8);
        // Set Sheet1!A1 to "Hello World!".
        workbook.Worksheets["Sheet1"].Cells["A1"].Value = "Hello World!";
        // Save to C:\MyData.xls again.
        workbook.Save();
        // 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 Sheet1!A1.
        System.Console.WriteLine(workbook.Worksheets["Sheet1"].Cells["A1"].Value.ToString());
    }
}

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()
        ' Save to C:\MyData.xls as an Excel file.
        workbook.SaveAs("C:\\MyData.xls", SpreadsheetGear.FileFormat.Excel8)
        ' Set Sheet1!A1 to "Hello World!".
        workbook.Worksheets("Sheet1").Cells("A1").Value = "Hello World!"
        ' Save to C:\MyData.xls again.
        workbook.Save()
        ' 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 Sheet1!A1.
        System.Console.WriteLine(workbook.Worksheets("Sheet1").Cells("A1").Value.ToString())
    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

IWorkbooks Interface
IWorkbooks Members
Overload List
Open(String,String) Method
Save Method
SaveAs(String,FileFormat) Method
SaveToMemory(FileFormat) Method
SaveToStream(Stream,FileFormat) Method
OpenFromMemory(Byte[]) Method
OpenFromStream(Stream) Method

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