IsExcelStream(Stream,ExcelWorkbookType,Boolean) Method

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
C#

'Declaration
 
Public Overloads Function IsExcelStream( _
   ByVal stream As Stream, _
   ByRef workbookType As ExcelWorkbookType, _
   ByRef isEncrypt As Boolean _
) As Boolean

'Usage
 
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)

public bool IsExcelStream( 
   Stream stream,
   ref ExcelWorkbookType workbookType,
   out bool isEncrypt
)

Parameters

stream: Stream
workbookType: Workbook type
isEncrypt: isEncrypt

Exceptions

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

Example

This example uses the IsExcelStream method.

FarPoint.Excel.ExcelWorkbookType en;
            en = FarPoint.Excel.ExcelWorkbookType.OOXML;
            bool isE;
            string s = "c:\\book1.xlsx";
            System.IO.FileStream str = new System.IO.FileStream(s, System.IO.FileMode.Open, System.IO.FileAccess.ReadWrite);

            bool b = fpSpread1.IsExcelStream(str, ref en, out isE);
            listBox1.Items.Add(b);
            if (b)
            {
                fpSpread1.OpenExcel(str, "Test");
            }

Visual Basic

Dim s As String = "c:\Book1.xlsx"
        Dim str As New System.IO.FileStream(s, IO.FileMode.Open, IO.FileAccess.ReadWrite)
        Dim b As Boolean = FpSpread1.IsExcelStream(str, FarPoint.Excel.ExcelWorkbookType.OOXML, True)
        If b Then
            FpSpread1.OpenExcel(str, "Test")
        End If

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows Server 2012 R2, Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8, Windows 8.1, Windows 10

Reference

FpSpread Class
FpSpread Members
Overload List