Click here to Skip to main content
14,544,175 members

C# - Retrieve Excel Workbook Sheet Names.

Rate this:
4.88 (84 votes)
Please Sign up or sign in to vote.
4.88 (84 votes)
25 Aug 2004
This article provides a way to retrieve the worksheet names of an Excel Workbook. This can be used to query a workbook using ADO.NET if you do not know the names of the worksheets.

Introduction

There are many examples using ADO.NET to query an Excel Workbook but they all have a limitation, you must know the worksheet name. This might work if you know the name of the worksheet, but what if you don't? If your program is dynamic and your sheet names differ for each Excel workbook, you need a way to extract the names of the sheets. The code example provides you with a way to retrieve the work sheet names.

The following method returns a string array containing the names of the sheets. The method also shows how to loop through the array. The method has one input parameter excelFile which is the location of the Excel file.

Code Example

/// <span class="code-SummaryComment"><summary></span>
/// This mehtod retrieves the excel sheet names from 
/// an excel workbook.
/// <span class="code-SummaryComment"></summary></span>
/// <span class="code-SummaryComment"><param name="excelFile">The excel file.</param></span>
/// <span class="code-SummaryComment"><returns>String[]</returns></span>
private String[] GetExcelSheetNames(string excelFile)
{
  OleDbConnection objConn = null;
  System.Data.DataTable dt = null;

  try
  {
    // Connection String. Change the excel file to the file you
    // will search.
    String connString = "Provider=Microsoft.Jet.OLEDB.4.0;" + 
        "Data Source=" + excelFile + ";Extended Properties=Excel 8.0;";
    // Create connection object by using the preceding connection string.
    objConn = new OleDbConnection(connString);
    // Open connection with the database.
    objConn.Open();
    // Get the data table containg the schema guid.
    dt = objConn.GetOleDbSchemaTable(OleDbSchemaGuid.Tables, null);
 
    if(dt == null)
    {
      return null;
    }

    String[] excelSheets = new String[dt.Rows.Count];
    int i = 0;

    // Add the sheet name to the string array.
    foreach(DataRow row in dt.Rows)
    {
      excelSheets[i] = row["TABLE_NAME"].ToString();
      i++;
    }

    // Loop through all of the sheets if you want too...
    for(int j=0; j < excelSheets.Length; j++)
    {
      // Query each excel sheet.
    }

    return excelSheets;
  }
  catch(Exception ex)
  {
    return null;
  }
  finally
  {
    // Clean up.
    if(objConn != null)
    {
      objConn.Close();
      objConn.Dispose();
    }
    if(dt != null)
    {
      dt.Dispose();
    }
  }
}

Enjoy...

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Kenneth Young
United States United States
No Biography provided

Comments and Discussions

 
QuestionHow to get the real names? Without $ or ' Pin
fanndibong6-Apr-08 18:39
Memberfanndibong6-Apr-08 18:39 
AnswerRe: How to get the real names? Without $ or ' Pin
FilipKrnjic24-Oct-11 22:03
MemberFilipKrnjic24-Oct-11 22:03 
GeneralGood article Pin
junique4-Mar-08 8:48
Memberjunique4-Mar-08 8:48 
GeneralRe: Good article Pin
ronny_2957-Jan-09 16:47
Memberronny_2957-Jan-09 16:47 
Generalaccess to excel Pin
hamed mahdavi7-Sep-07 7:37
Memberhamed mahdavi7-Sep-07 7:37 
GeneralC# - Inserting Rows in Excel WorkSheet Pin
XBenedict12-Jul-07 22:04
MemberXBenedict12-Jul-07 22:04 
GeneralRe: C# - Inserting Rows in Excel WorkSheet Pin
privacy space23-Aug-07 22:35
Memberprivacy space23-Aug-07 22:35 
GeneralPassword Protected Pin
RedDogEdward5-Dec-06 1:51
MemberRedDogEdward5-Dec-06 1:51 
GeneralDoesn't seem to work with Excel 5.0 files. Pin
tolsen649-Feb-06 12:37
Membertolsen649-Feb-06 12:37 
GeneralAdd Worksheet Pin
HakunaMatada7-Oct-05 20:25
MemberHakunaMatada7-Oct-05 20:25 
GeneralGetting retriving excel sheets Pin
godfathers2-Mar-05 22:09
Membergodfathers2-Mar-05 22:09 
GeneralRe: Getting retriving excel sheets Pin
abhi kumar16-Aug-05 20:05
Memberabhi kumar16-Aug-05 20:05 
QuestionA Better Way??? Pin
Anonymous30-Oct-04 12:32
MemberAnonymous30-Oct-04 12:32 
AnswerRe: A Better Way??? Pin
Mike Ellison30-Oct-04 13:59
MemberMike Ellison30-Oct-04 13:59 
GeneralExcel Sheets Pin
Anonymous15-Sep-04 9:23
MemberAnonymous15-Sep-04 9:23 
GeneralGood Work Pin
Terence Wallace30-Aug-04 17:45
MemberTerence Wallace30-Aug-04 17:45 
Generalgood tip Pin
Ashley van Gerven26-Aug-04 16:31
MemberAshley van Gerven26-Aug-04 16:31 
GeneralRe: good tip Pin
Labrat00226-Aug-04 20:17
MemberLabrat00226-Aug-04 20:17 
GeneralRe: good tip Pin
Ashley van Gerven30-Aug-04 3:18
MemberAshley van Gerven30-Aug-04 3:18 
QuestionHidden Sheets? Pin
Mike Ellison26-Aug-04 7:12
MemberMike Ellison26-Aug-04 7:12 
AnswerRe: Hidden Sheets? Pin
Kenneth Young30-Aug-04 9:47
MemberKenneth Young30-Aug-04 9:47 
QuestionRe: Hidden Sheets? Pin
ankitbansal8230-Oct-06 1:16
Memberankitbansal8230-Oct-06 1:16 
AnswerRe: Hidden Sheets? Pin
SuperDuckZA_PS27-Jul-07 2:26
MemberSuperDuckZA_PS27-Jul-07 2:26 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

Article
Posted 25 Aug 2004

Stats

486.2K views
107 bookmarked