OpenExcelAsync(Stream,Int32) Method

Opens an Excel Compound Document File and loads it into GcSpreadSheet.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function OpenExcelAsync( _
   ByVal stream As Stream, _
   ByVal sheetIndex As Integer _
) As IAsyncAction

'Usage
 
Dim instance As Workbook
Dim stream As Stream
Dim sheetIndex As Integer
Dim value As IAsyncAction
 
value = instance.OpenExcelAsync(stream, sheetIndex)

public IAsyncAction OpenExcelAsync( 
   Stream stream,
   int sheetIndex
)

Parameters

stream: The stream that contains the Excel Compound Document File.
sheetIndex: The index of sheet in Excel file.

Return Value

Whether the file opened successfully.

Exceptions

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

Remarks

For performance considerations, this method suspends all events during a file load.

Requirements

Target Platforms: Windows Server 2012, Windows RT

Reference

Workbook Class
Workbook Members
Overload List