Spread Windows Forms 7.0 Product Documentation
IsExcelStream(Stream,ExcelWorkbookType) Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > FpSpread Class > IsExcelStream Method : IsExcelStream(Stream,ExcelWorkbookType) Method


stream
Stream
workbookType
Workbook type

Glossary Item Box

Opens the specified file and determines whether it meets the minimal requirements to be considered a stream that contains an Excel workbook.

Syntax

Visual Basic (Declaration) 
Public Overloads Function IsExcelStream( _
   ByVal stream As Stream, _
   ByRef workbookType As ExcelWorkbookType _
) As Boolean
Visual Basic (Usage)Copy Code
Dim instance As FpSpread
Dim stream As Stream
Dim workbookType As ExcelWorkbookType
Dim value As Boolean
 
value = instance.IsExcelStream(stream, workbookType)
C# 
public bool IsExcelStream( 
   Stream stream,
   ref ExcelWorkbookType workbookType
)

Parameters

stream
Stream
workbookType
Workbook type

Exceptions

ExceptionDescription
System.ArgumentNullExceptionNo stream specified or specified stream is null
System.ArgumentExceptionNo stream specified or specified stream is empty

Example

This example opens the excel file if it is determined to be one.
C#Copy Code
string s = "c:\\test.xls";
System.IO.FileStream str = new System.IO.FileStream(s, IO.FileMode.Open, IO.FileAccess.ReadWrite);
bool b = fpSpread1.IsExcelStream(str, FarPoint.Excel.ExcelWorkbookType.BIFF);
if (b)
{
fpSpread1.OpenExcel(s);
}
Visual BasicCopy Code
Dim s As String = "c:\test.xls"
Dim str As New System.IO.FileStream(s, IO.FileMode.Open, IO.FileAccess.ReadWrite)
Dim b As Boolean = FpSpread1.IsExcelStream(str, FarPoint.Excel.ExcelWorkbookType.BIFF)
If b Then
FpSpread1.OpenExcel(s)
End If

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

See Also

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.