Back to Devexpress

ChartObject.MoveToNewChartSheet(String) Method

officefileapi-devexpress-dot-spreadsheet-dot-charts-dot-chartobject-dot-movetonewchartsheet-x28-system-dot-string-x29.md

latest5.7 KB
Original Source

ChartObject.MoveToNewChartSheet(String) Method

Moves the current chart to a separate chart sheet.

Namespace : DevExpress.Spreadsheet.Charts

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
ChartSheet MoveToNewChartSheet(
    string name
)
vb
Function MoveToNewChartSheet(
    name As String
) As ChartSheet

Parameters

NameTypeDescription
nameString

A String value that specifies the name of the new chart sheet.

|

Returns

TypeDescription
ChartSheet

A newly created ChartSheet or null ( Nothing in Visual Basic), if a chart sheet cannot be created.

|

Remarks

When naming a chart sheet, take into account the following constraints:

  • A chart sheet name must not be equal to a name that is already contained in the collection of existing sheets (IWorkbook.Sheets).
  • A chart sheet name must not exceed 31 characters.
  • A chart sheet name must not contain the following symbols: , /, ?, :, *, [or]
  • A chart sheet name must not start and end with a single quote (‘).
  • A chart sheet name must not be an empty string.

Example

The following example demonstrates how to move an existing chart from a worksheet to a separate chart sheet. To do this, call the ChartObject.MoveToNewChartSheet method for a chart you wish to move.

To transfer a chart back to the worksheet containing the source data, use the ChartObject.MoveToWorksheet method.

View Example

csharp
Worksheet worksheet = workbook.Worksheets["chartTask1"];

// Create an embedded chart on the worksheet.
Chart chart = worksheet.Charts.Add(ChartType.Pie, worksheet["B2:C7"]);
chart.TopLeftCell = worksheet.Cells["E2"];
chart.BottomRightCell = worksheet.Cells["K15"];

// Move the chart to a chart sheet.
ChartSheet chartSheet = chart.MoveToNewChartSheet("Chart");

workbook.ChartSheets.ActiveChartSheet = chartSheet;
vb
Dim worksheet As Worksheet = workbook.Worksheets("chartTask1")

' Create an embedded chart on the worksheet.
Dim chart As Chart = worksheet.Charts.Add(ChartType.Pie, worksheet("B2:C7"))
chart.TopLeftCell = worksheet.Cells("E2")
chart.BottomRightCell = worksheet.Cells("K15")

' Move the chart to a chart sheet.
Dim chartSheet As ChartSheet = chart.MoveToNewChartSheet("Chart")

workbook.ChartSheets.ActiveChartSheet = chartSheet

The following code snippets (auto-collected from DevExpress Examples) contain references to the MoveToNewChartSheet(String) 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.

wpf-spreadsheet-chart-api/CS/SpreadsheetWPFChartAPISamples/CodeExamples/ChartSheetActions.cs#L95

csharp
// Move the chart to a chart sheet.
ChartSheet chartSheet = chart.MoveToNewChartSheet("Chart");

winforms-spreadsheet-chart-api/CS/SpreadsheetChartAPISamples/CodeExamples/ChartSheetActions.cs#L95

csharp
// Move the chart to a chart sheet.
ChartSheet chartSheet = chart.MoveToNewChartSheet("Chart");

wpf-spreadsheet-chart-api/VB/SpreadsheetWPFChartAPISamples/CodeExamples/ChartSheetActions.vb#L92

vb
' Move the chart to a chart sheet.
Dim chartSheet As ChartSheet = chart.MoveToNewChartSheet("Chart")

winforms-spreadsheet-chart-api/VB/SpreadsheetChartAPISamples/CodeExamples/ChartSheetActions.vb#L91

vb
' Move the chart to a chart sheet.
Dim chartSheet As ChartSheet = chart.MoveToNewChartSheet("Chart")

See Also

ChartObject Interface

ChartObject Members

DevExpress.Spreadsheet.Charts Namespace