OpenExcel(Stream) Method

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

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Sub OpenExcel( _
   ByVal stream As System.IO.Stream _
)

'Usage
 
Dim instance As Workbook
Dim stream As System.IO.Stream
 
instance.OpenExcel(stream)

public void OpenExcel( 
   System.IO.Stream stream
)

Parameters

stream: The stream that contains the Excel Compound Document 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.

Example

This example opens a file with the Workbook class.

Microsoft.Win32.OpenFileDialog openFileDialog = new Microsoft.Win32.OpenFileDialog();
            openFileDialog.Filter = "Excel File (.xls)|*.xls";
            bool? useClick = openFileDialog.ShowDialog();
            if (useClick == true)
            {
                var stream = openFileDialog.OpenFile();
                stream.Seek(0, System.IO.SeekOrigin.Begin);
                GrapeCity.Windows.SpreadSheet.Data.Workbook test = new GrapeCity.Windows.SpreadSheet.Data.Workbook(2);
                test.OpenExcel(stream);
                stream.Dispose();                
            }

VB.NET

Dim openFileDialog = New Microsoft.Win32.OpenFileDialog()
        openFileDialog.Filter = "Excel File(.xls)|*.xls"
        Dim useClick As Boolean = openFileDialog.ShowDialog()
        If (useClick = True) Then
            Dim stream = openFileDialog.OpenFile()
            stream.Seek(0, IO.SeekOrigin.Begin)
            Dim test As New GrapeCity.Windows.SpreadSheet.Data.Workbook(2)
            test.OpenExcel(stream)
            stream.Dispose()
        End If

Reference

Workbook Class
Workbook Members
Overload List