Spread Windows Forms 6.0 Product Documentation
GetExcelSheetNames(String) Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > FpSpread Class > GetExcelSheetNames Method : GetExcelSheetNames(String) Method


fileName
Path and name of file

Glossary Item Box

Gets an array of sheet names from the specified Excel-compatible file.

Syntax

Visual Basic (Declaration) 
Public Overloads Shared Function GetExcelSheetNames( _
   ByVal fileName As String _
) As String()
Visual Basic (Usage)Copy Code
Dim fileName As String
Dim value() As String
 
value = FpSpread.GetExcelSheetNames(fileName)
C# 
public static string[] GetExcelSheetNames( 
   string fileName
)

Parameters

fileName
Path and name of file

Return Value

String array containing the names of the sheets in the Excel-compatible file

Exceptions

ExceptionDescription
System.IO.FileNotFoundExceptionSpecified file is not found
System.ArgumentNullExceptionNo file name is specified (or specified file name is null)
System.ArgumentExceptionNo file name is specified (or specified file name is empty)

Example

This example gets an array of sheet names from the specified Excel file.
C#Copy Code
FarPoint.Win.Spread.FpSpread fpSpread1 = new FarPoint.Win.Spread.FpSpread();
FarPoint.Win.Spread.SheetView shv = new FarPoint.Win.Spread.SheetView();
fpSpread1.Location = new Point(10, 10);
fpSpread1.Height = 200;
fpSpread1.Width = 400;
Controls.Add(fpSpread1);
fpSpread1.Sheets.Add(shv);
String[] sheetNames = FarPoint.Win.Spread.FpSpread.GetExcelSheetNames("..\\..\\bin\\Book1.xls");
listBox1.Items.Add(sheetNames[0].ToString());
Visual BasicCopy Code
Dim fpSpread1 As New FarPoint.Win.Spread.FpSpread()
Dim shv As New FarPoint.Win.Spread.SheetView()
fpSpread1.Location = New Point(10, 10)
fpSpread1.Height = 200
fpSpread1.Width = 400
Controls.Add(fpSpread1)
fpSpread1.Sheets.Add(shv)
Dim sheetNames As [String]() = fpSpread1.GetExcelSheetNames("..\bin\Book1.xls")
ListBox1.Items.Add(sheetNames(0).ToString())

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

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