OpenExcel(Stream,Int32) Method

Opens an Excel file and loads the specified Excel sheet into this sheet.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function OpenExcel( _
   ByVal stream As Stream, _
   ByVal excelSheetIndex As Integer _
) As Boolean

'Usage
 
Dim instance As SheetView
Dim stream As Stream
Dim excelSheetIndex As Integer
Dim value As Boolean
 
value = instance.OpenExcel(stream, excelSheetIndex)

public bool OpenExcel( 
   Stream stream,
   int excelSheetIndex
)

Parameters

stream: Stream containing an Excel Compound Document File
excelSheetIndex: Index of the Excel sheet to load

Return Value

Boolean: true if successful; false otherwise

Exceptions

Exception	Description
FarPoint.Excel.ExcelException	Specified sheet in Excel is invalid; index must be between 0 and the number of sheets

Example

This example uses the OpenExcel method.

System.IO.Stream s;
s = System.IO.File.Open("C:\\controls\\book1.xlsx", System.IO.FileMode.Open);
//FpSpread1.Sheets[0].OpenExcel(s, "Sheet1");
//FpSpread1.Sheets[0].OpenExcel(s, 0);
//FpSpread1.Sheets[0].OpenExcel(s, "Sheet1", FarPoint.Excel.ExcelOpenFlags.DataOnly);
//FpSpread1.Sheets[0].OpenExcel(s, "Sheet1", FarPoint.Excel.ExcelOpenFlags.DataOnly, "123*");
//FpSpread1.Sheets[0].OpenExcel(s, 0, FarPoint.Excel.ExcelOpenFlags.DataOnly);
FpSpread1.Sheets[0].OpenExcel(s, 0, FarPoint.Excel.ExcelOpenFlags.DataOnly, "123*");

VB.NET

Dim s As System.IO.Stream
s = System.IO.File.Open("C:\controls\book1.xlsx", System.IO.FileMode.Open)
'FpSpread1.Sheets(0).OpenExcel(s, "Sheet1")
'FpSpread1.Sheets(0).OpenExcel(s, 0)
FpSpread1.Sheets(0).OpenExcel(s, "Sheet1", FarPoint.Excel.ExcelOpenFlags.DataOnly)
'FpSpread1.Sheets(0).OpenExcel(s, "Sheet1", FarPoint.Excel.ExcelOpenFlags.DataOnly, "123*")
'FpSpread1.Sheets(0).OpenExcel(s, 0, FarPoint.Excel.ExcelOpenFlags.DataOnly)
'FpSpread1.Sheets(0).OpenExcel(s, 0, FarPoint.Excel.ExcelOpenFlags.DataOnly, "123*")

Requirements

Target Platforms: Windows 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

Reference

SheetView Class
SheetView Members
Overload List