Spread for ASP.NET 7.0 Product Documentation
IsExcelStream(Stream,ExcelWorkbookType,Boolean) Method
See Also  Support Options
FarPoint.Web.Spread Assembly > FarPoint.Web.Spread Namespace > FpSpread Class > IsExcelStream Method : IsExcelStream(Stream,ExcelWorkbookType,Boolean) Method


stream
Stream
workbookType
Returns the type of Excel workbook
isEncrypt
If set to true excel data is encrypted.

Glossary Item Box

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

Syntax

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

Parameters

stream
Stream
workbookType
Returns the type of Excel workbook
isEncrypt
If set to true excel data is encrypted.

Return Value

true if the specified stream contains excel data; otherwise, false.

Exceptions

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

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

See Also

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