OpenExcel(Stream,ExcelOpenFlags,ExcelWarningList,String,Boolean) Method

Opens an Excel Compound Document File and loads it into Spread with a list of warnings.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function OpenExcel( _
   ByVal stream As Stream, _
   ByVal openFlags As ExcelOpenFlags, _
   ByVal warningList As ExcelWarningList, _
   ByVal password As String, _
   ByVal isClearInputMapKey As Boolean _
) As Boolean

'Usage
 
Dim instance As FpSpread
Dim stream As Stream
Dim openFlags As ExcelOpenFlags
Dim warningList As ExcelWarningList
Dim password As String
Dim isClearInputMapKey As Boolean
Dim value As Boolean
 
value = instance.OpenExcel(stream, openFlags, warningList, password, isClearInputMapKey)

public bool OpenExcel( 
   Stream stream,
   ExcelOpenFlags openFlags,
   ExcelWarningList warningList,
   string password,
   bool isClearInputMapKey
)

Parameters

stream: Stream
openFlags: Open flag
warningList: List of Excel warnings
password: File password
isClearInputMapKey: Clear current input map key

Exceptions

Exception	Description
System.ArgumentNullException	No stream specified or specified stream is null
System.ArgumentException	No stream specified or specified stream is empty

Example

This example uses the OpenExcel method.

string f;  
f = "D:\\mptest.xls";  
System.IO.FileStream s = new System.IO.FileStream(f, System.IO.FileMode.Open, System.IO.FileAccess.ReadWrite); 
fpSpread1.OpenExcel(s, FarPoint.Excel.ExcelOpenFlags.DataOnly, new FarPoint.Excel.ExcelWarningList(), "test", true);

Visual Basic

Dim f As String 
f = "D:\mptest.xls"
Dim s As New System.IO.FileStream(f, IO.FileMode.Open,IO.FileAccess.ReadWrite)
FpSpread1.OpenExcel(s, FarPoint.Excel.ExcelOpenFlags.DataOnly, New FarPoint.Excel.ExcelWarningList(), "test", True)

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

Reference

FpSpread Class
FpSpread Members
Overload List