How to: Programmatically Copy Worksheets

 

You can create a copy of a worksheet, and insert that worksheet before or after an existing worksheet in the workbook. If you do not specify where to insert the worksheet, Excel creates a new workbook to contain the new worksheet.

Applies to: The information in this topic applies to document-level projects and VSTO add-in projects for Excel. For more information, see Features Available by Office Application and Project Type.

System_CAPS_ICON_note.jpg Note


Whether you copy the worksheet programmatically, or the end user copies the worksheet manually, there is no code behind the new worksheet and controls on the new worksheet do not function. This is because the newly copied worksheet is a Microsoft.Office.Interop.Excel.Worksheet object and not a Microsoft.Office.Tools.Excel.Worksheet host item. Windows Forms controls and host controls can only be added to host items. For more information, see Programmatic Limitations of Host Items and Host Controls.

To add a copied worksheet to a workbook in a document-level customization

  1. Use the Copy method to copy the first worksheet in the current workbook and place the copy after the third sheet.

                Globals.Sheet1.Copy(Globals.ThisWorkbook.Sheets[3]);
    

To add a copied worksheet to a workbook in a VSTO Add-in

  1. Use the Copy method to copy the first worksheet in the current workbook and place the copy after the third sheet.

                Excel.Worksheet worksheet1 = ((Excel.Worksheet)Application.ActiveWorkbook.Worksheets[1]);
                Excel.Worksheet worksheet3 = ((Excel.Worksheet)Application.ActiveWorkbook.Worksheets[3]);
                worksheet1.Copy(worksheet3);
    

Working with Worksheets
Host Items and Host Controls Overview
How to: Programmatically Add New Worksheets to Workbooks
How to: Programmatically Delete Worksheets from Workbooks
How to: Programmatically Select Worksheets
Automating Excel by Using Extended Objects
Global Access to Objects in Office Projects
Programmatic Limitations of Host Items and Host Controls
Optional Parameters in Office Solutions

Show: