OfficeWriter Documentation
.
ExcelWriter v8 Docs
Space Shortcuts
Page tree
ConfigureSpace tools

Versions Compared

Old Version 7

changes.mady.by.user Unknown User (ozgurt)

Saved on

compared with

New Version Current

changes.mady.by.user Unknown User (ozgurt)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Description

Excerpt

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

Signature
C#
C#
 public virtual Workbook Open(System.IO.Stream stream, System.String decryptPassword)
Signature
vb.net
vb.net
Public Overridable Function Open(ByVal stream As System.IO.Stream, ByVal decryptPassword As String) As Workbook
Parameters
Param
stream
stream

A System.IO.Stream containing a OOXML format (Excel 2007 or later) .xlsx or BIFF8 format (Excel 97 or later) .xls file.

Param
decryptPassword
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.

Returns

A Workbook object representing the file to open.

Exceptions
Exception
System.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
ArgumentException
ArgumentException

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.

Example
Code Block
csharp
csharp
titleC#

          ExcelApplication xla = new ExcelApplication();
          FileStream fStrm = new FileStream(@"C:\Sales\2003\June.xlsx", FileMode.Open);
          Workbook wb = xla.Open(fStrm, "MyPassword");
Code Block
vb.net
vb.net
titlevb.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")