Worksheet.CopyFrom(Worksheet) Method

Copies the specified worksheet into the current instance.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

void CopyFrom(
    Worksheet source
)

VB.NET

Sub CopyFrom(
    source As Worksheet
)

Parameters

Name	Type	Description
source	Worksheet	A Worksheet object that specifies the source worksheet for copying.

Example

This example demonstrates how to create a copy of an existing worksheet. To do this, follow the steps below.

• Create an empty worksheet in a workbook. For example, call the WorksheetCollection.Add method.
• Access the newly created worksheet object and call its Worksheet.CopyFrom method with the source worksheet object passed as a parameter.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/spreadsheet-document-server-api-e4339

WorksheetActions.cs

// Add a new worksheet to a workbook.
workbook.Worksheets.Add("Sheet1_Copy");

// Copy all information (content and formatting) to the newly created worksheet 
// from the "Sheet1" worksheet.
workbook.Worksheets["Sheet1_Copy"].CopyFrom(workbook.Worksheets["Sheet1"]);

WorksheetActions.vb

' Add a new worksheet to a workbook.
workbook.Worksheets.Add("Sheet1_Copy")

' Copy all information (content and formatting) to the newly created worksheet 
' from the "Sheet1" worksheet.
workbook.Worksheets("Sheet1_Copy").CopyFrom(workbook.Worksheets("Sheet1"))

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CopyFrom(Worksheet) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

spreadsheet-document-api-examples-part1/CS/SpreadsheetExamples/SpreadsheetActions/WorksheetActions.cs#L79

// from the "Sheet1" worksheet.
workbook.Worksheets["Sheet1_Copy"].CopyFrom(workbook.Worksheets["Sheet1"]);
#endregion #CopyWorksheet

Reporting_how-to-export-reports-to-different-sheets-in-an-xlsx-file-by-using-spreadsheet-e4892/CS/WindowsFormsApplication1/Form1.cs#L44

workbook.Worksheets.Insert(1,"report2");
workbook.Worksheets[1].CopyFrom(workbook2.Worksheets[0]);
workbook.SaveDocument("test3.xlsx");

spreadsheet-document-api-chart-examples/CS/SpreadsheetDocServerChartAPISamples/Form1.cs#L442

tempWorkbook.CreateNewDocument();
tempWorkbook.Worksheets[0].CopyFrom(workbook.Worksheets.ActiveWorksheet);
tempWorkbook.SaveDocument(fileName);

wpf-spreadsheetcontrol-api-part-1-e4938/CS/SpreadsheetControl_WPF_API/SpreadsheetActions/WorksheetActions.cs#L97

// from the "Sheet1" worksheet.
workbook.Worksheets["Sheet1_Copy"].CopyFrom(workbook.Worksheets["Sheet1"]);
#endregion #CopyWorksheet

winforms-spreadsheetcontrol-api-e4655/CS/SpreadsheetControl/SpreadsheetActions/WorksheetActions.cs#L83

// from the "Sheet1" worksheet.
workbook.Worksheets["Sheet1_Copy"].CopyFrom(workbook.Worksheets["Sheet1"]);
#endregion #CopyWorksheet

VB.NET

spreadsheet-document-api-examples-part1/VB/SpreadsheetExamples/SpreadsheetActions/WorksheetActions.vb#L83

            ' from the "Sheet1" worksheet.
            workbook.Worksheets("Sheet1_Copy").CopyFrom(workbook.Worksheets("Sheet1"))
'            #End Region ' #CopyWorksheet

Reporting_how-to-export-reports-to-different-sheets-in-an-xlsx-file-by-using-spreadsheet-e4892/VB/WindowsFormsApplication1/Form1.vb#L46

workbook.Worksheets.Insert(1,"report2")
workbook.Worksheets(1).CopyFrom(workbook2.Worksheets(0))
workbook.SaveDocument("test3.xlsx")

spreadsheet-document-api-chart-examples/VB/SpreadsheetDocServerChartAPISamples/Form1.vb#L423

tempWorkbook.CreateNewDocument()
tempWorkbook.Worksheets(0).CopyFrom(workbook.Worksheets.ActiveWorksheet)
tempWorkbook.SaveDocument(fileName)

wpf-spreadsheetcontrol-api-part-1-e4938/VB/SpreadsheetControl_WPF_API/SpreadsheetActions/WorksheetActions.vb#L90

                ' from the "Sheet1" worksheet.
                workbook.Worksheets("Sheet1_Copy").CopyFrom(workbook.Worksheets("Sheet1"))
'                #End Region ' #CopyWorksheet

winforms-spreadsheetcontrol-api-e4655/VB/SpreadsheetControl/SpreadsheetActions/WorksheetActions.vb#L86

            ' from the "Sheet1" worksheet.
            workbook.Worksheets("Sheet1_Copy").CopyFrom(workbook.Worksheets("Sheet1"))
'            #End Region ' #CopyWorksheet