OpenExcel(Stream,Int32,Int32,ExcelWarningList) Method

Opens an Excel stream and loads the specified Excel sheet (by index) into this sheet of the Spread component (by index) keeping track of warnings.

Syntax

Visual Basic
C#

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

'Usage
 
Dim instance As FpSpread
Dim stream As Stream
Dim spreadSheetIndex As Integer
Dim excelSheetIndex As Integer
Dim warningList As ExcelWarningList
Dim value As Boolean
 
value = instance.OpenExcel(stream, spreadSheetIndex, excelSheetIndex, warningList)

public bool OpenExcel( 
   Stream stream,
   int spreadSheetIndex,
   int excelSheetIndex,
   ExcelWarningList warningList
)

Parameters

stream: Stream that contains an Excel Compound Storage file
spreadSheetIndex: Index of the Spread component sheet into which the Excel sheet is to load
excelSheetIndex: Index of the Excel sheet to load
warningList: List of warning messages that occur during this operation

Return Value

Boolean: true if successful; false otherwise

Example

string f;
f = "D:\openexcel.xls";
System.IO.FileStream s = new System.IO.FileStream(f, IO.FileMode.Open, IO.FileAccess.ReadWrite);
if (!IsPostBack)
{
    FarPoint.Excel.ExcelWarning w = new FarPoint.Excel.ExcelWarningList();
    FpSpread1.OpenExcel(s, 0, 1, w);
}

Visual Basic

Dim f As String
f = "D:\openexcel.xls"
Dim s As New System.IO.FileStream(f, IO.FileMode.Open, IO.FileAccess.ReadWrite)
If Not IsPostBack Then
    Dim w As New FarPoint.Excel.ExcelWarningList
    FpSpread1.OpenExcel(s, 0, 1, w)
End If

Requirements

Target Platforms: Windows 7, Windows 8, Windows 10, Windows Vista, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows XP Professional

Parameters

Return Value

Reference

User-Task Documentation

External