IsExcelFile(String,ExcelWorkbookType,Boolean) Method

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

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function IsExcelFile( _
   ByVal fileName As String, _
   ByRef workbookType As ExcelWorkbookType, _
   ByRef isEncrypt As Boolean _
) As Boolean

'Usage
 
Dim instance As FpSpread
Dim fileName As String
Dim workbookType As ExcelWorkbookType
Dim isEncrypt As Boolean
Dim value As Boolean
 
value = instance.IsExcelFile(fileName, workbookType, isEncrypt)

public bool IsExcelFile( 
   string fileName,
   ref ExcelWorkbookType workbookType,
   out bool isEncrypt
)

Parameters

fileName: Path and name of file
workbookType: Returns the type of Excel workbook
isEncrypt: Returns true the file is encrypted; false otherwise

Exceptions

Exception	Description
System.IO.FileNotFoundException	Specified file is not found
System.ArgumentNullException	No file name is specified (or specified file name is null)
System.ArgumentException	No file name is specified (or specified file name is empty)

Example

This example uses the IsExcelFile method.

FarPoint.Excel.ExcelWorkbookType en;
            en = FarPoint.Excel.ExcelWorkbookType.OOXML;
            bool isE;
            string s = "c:\\book1.xlsx";
            bool b = fpSpread1.IsExcelFile(s, ref en, out isE);
            listBox1.Items.Add(b);
            if (b)
            {
                fpSpread1.OpenExcel(s, "Test");
            }

Visual Basic

Dim isE As Boolean
        Dim s As String = "c:\book1.xlsx"
        Dim b As Boolean = FpSpread1.IsExcelFile(s, FarPoint.Excel.ExcelWorkbookType.OOXML, isE)
        ListBox1.Items.Add(b)
        If (b) Then
            FpSpread1.OpenExcel(s, "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