Click here to Skip to main content
11,568,522 members (43,029 online)
Click here to Skip to main content

C# - Retrieve Excel Workbook Sheet Names.

, 25 Aug 2004 371K 106
Rate this:
Please Sign up or sign in to vote.
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

Kenny Young
United States United States
Ken currently works as the Director of Software Engineering at the Pediatrics Epidemiology Center at the University of South Florida. He is involved in the architecture and design on numerous clinical trial projects. Some of the project include:

1. Rare Diseases Clinical Research Network
2. TrialNet - Diabetes
3. Teddy - Diabetes
4. CCOP - Cancer
5. AIDA - Diabetes

You may also be interested in...

Comments and Discussions

 
GeneralMy vote of 5 Pin
padmanabhan N10-Dec-10 0:30
memberpadmanabhan N10-Dec-10 0:30 
Thanks for your code.
GeneralC# to C++ Pin
maklein9918-Oct-10 6:31
membermaklein9918-Oct-10 6:31 
GeneralMy vote of 5 Pin
n52615-Jul-10 18:41
membern52615-Jul-10 18:41 
GeneralOrder of Table Pin
Tom arnold25-Feb-10 15:53
memberTom arnold25-Feb-10 15:53 
GeneralExcellent Pin
MAP Tiger14-Jan-10 18:26
memberMAP Tiger14-Jan-10 18:26 
Generalgetting error "no error message available, result code:E_UNEXPECTED (0x8000FFFF) Pin
Alamelu Suresh10-Nov-09 19:31
memberAlamelu Suresh10-Nov-09 19:31 
QuestionHow can i use this code on linux Pin
Alex_30208647-Sep-09 1:35
memberAlex_30208647-Sep-09 1:35 
GeneralGreat! Pin
pjvanzyl@yahoo.com30-Jun-09 2:32
memberpjvanzyl@yahoo.com30-Jun-09 2:32 
GeneralThanks Pin
Kenneth_Scott11-Jun-09 6:26
memberKenneth_Scott11-Jun-09 6:26 
GeneralVery Helpful Pin
accusteve25-Mar-09 9:10
memberaccusteve25-Mar-09 9:10 
GeneralVery useful Artical Pin
sorabh.jain17-Feb-09 19:43
membersorabh.jain17-Feb-09 19:43 
GeneralOrder of Tabs Pin
sdb777-Oct-08 3:52
membersdb777-Oct-08 3:52 
GeneralRe: Order of Tabs Pin
Khan_alpha15-Sep-09 6:47
memberKhan_alpha15-Sep-09 6:47 
GeneralRe: Order of Tabs Pin
sdb7715-Sep-09 8:13
membersdb7715-Sep-09 8:13 
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
hamedeng7-Sep-07 7:37
memberhamedeng7-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
Bikash Rai7-Oct-05 20:25
memberBikash Rai7-Oct-05 20:25 
GeneralGetting retriving excel sheets Pin
godfathers2-Mar-05 22:09
membergodfathers2-Mar-05 22:09 

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

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

| Advertise | Privacy | Terms of Use | Mobile
Web03 | 2.8.150624.2 | Last Updated 26 Aug 2004
Article Copyright 2004 by Kenny Young
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid