Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Description

Excerpt

Opens an Excel workbook from a stream and returns a Workbook object.

Signature
C#C#
Wiki Markup
{description}
{excerpt}Opens an Excel workbook from a  stream and returns a [Workbook|Workbook] object.{excerpt}
{signature:C#}
 public virtual Workbook Open(System.IO.Stream stream, System.String decryptPassword)
Signature
{signature}{signature:vb.net
vb.net
}
Public Overridable Function Open(ByVal stream As System.IO.Stream, ByVal decryptPassword As String) As Workbook
Parameters
Param
streamstreamA
{signature}
{parameters}
{param:stream}A System.IO.Stream containing a OOXML format \(Excel 2007 or later\) .xlsx or BIFF8 format \(Excel 97 or later\) .xls file.
Param
decryptPassworddecryptPassword

The password used to encrypt the spreadsheet. Standard "Office 97/2000 Compatible" encryption is used to encrypt the spreadsheet. This is the default encryption used by Excel 97 and later versions.

Returns

A Workbook object representing the file to open.

Exceptions

...

If the file cannot be found or opened, or if the file is not a OOXML format (Excel 2007 or later) .xlsx or BIFF8 format (Excel 97 or later) .xls file.

...

If decryptPassword is not the password that can decrypt the workbook.

Remarks

ExcelWriter supports Excel's OOXML (Excel 2007 or later) and BIFF8 (Excel 97 or later) format only. Do not use this method to open BIFF7 (Excel 95) files.

Note that ExcelWriter will not automatically re-encrypt a workbook that was opened with this method. If you want to ensure that your workbook is encrypted when saved, set the EncryptPassword property.

{param}
{param:decryptPassword}The password used to encrypt the spreadsheet. Standard "Office 97/2000 Compatible" encryption is used  to encrypt the spreadsheet. This is the default encryption used by Excel 97 and later versions.{param}
{returns}A {{Workbook}} object representing the file to open.{returns}
{exceptions}
{exception:System.Exception}If the file cannot be found or opened, or if the file is not a OOXML format \(Excel 2007 or later\) .xlsx or BIFF8 format \(Excel 97 or later\) .xls file.{exception}
{exception:ArgumentException}
If {{decryptPassword}} is not the password that can decrypt the workbook.
{exception}
{remarks}ExcelWriter supports  Excel's OOXML \(Excel 2007 or later\) and BIFF8 \(Excel 97 or later\) format only.  Do not use this method  to open BIFF7 \(Excel 95\) files.

Note that ExcelWriter will not automatically re-encrypt a workbook that was opened with this method.  If you want to ensure that your workbook is encrypted when saved, set the [{{EncryptPassword}}|Workbook.EncryptPassword] property.
{remarks}
{example}{code:csharp|title=C#}

          ExcelApplication xla = new ExcelApplication();
          FileStream fStrm = new FileStream(@"C:\Sales\2003\June.xlsx", FileMode.Open);
          Workbook wb = xla.Open(fStrm, "MyPassword");
        
{code}
{code:vb.net
|title=vb.net
}

          Dim xla As New ExcelApplication()
          Dim fStrm As FileStream = New FileStream("C:\Sales\2003\June.xlsx")
          Dim wb As Workbook = xla.Open(fStrm, "MyPassword")
        {code}

{example}
Example
Code Block
csharpcsharp
titleC#
Code Block
vb.nettitle