The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+
Row

ExternalWorkbookCollection.Add(ExternalWorkbook, String) Method

Adds a new workbook to the ExternalWorkbookCollection collection.

Namespace: DevExpress.Spreadsheet

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

Declaration

void Add(
    ExternalWorkbook item,
    string alias
)
Sub Add(
    item As ExternalWorkbook,
    alias As String
)
void Add(
    ExternalWorkbook item,
    string alias
)
Sub Add(
    item As ExternalWorkbook,
    alias As String
)
void Add(
    ExternalWorkbook item,
    string alias
)
Sub Add(
    item As ExternalWorkbook,
    alias As String
)

Parameters

Name Type Description
item ExternalWorkbook

An ExternalWorkbook object specifying the workbook to be added to the collection.

alias String

A String value specifying the custom workbook name that can be used in external references.

Parameters

Name Type Description
item ExternalWorkbook

An ExternalWorkbook object specifying the workbook to be added to the collection.

alias String

A String value specifying the custom workbook name that can be used in external references.

Parameters

Name Type Description
item ExternalWorkbook

An ExternalWorkbook object specifying the workbook to be added to the collection.

alias String

A String value specifying the custom workbook name that can be used in external references.

Remarks

The alias parameter of the current Add method allows you to specify a custom workbook name that you can use in external references instead of the original file name or when the external workbook is not saved to a file.

using DevExpress.Spreadsheet;
// ...

// Access the current workbook where you wish to use external references. 
IWorkbook workbook = spreadsheetControl1.Document;
Worksheet worksheet = workbook.Worksheets[0];

// Access the source workbook that contains cells to be referred to from the current workbook. 
IWorkbook sourceWorkbook = spreadsheetControl2.Document;
sourceWorkbook.LoadDocument(@"c:\Temp\Book1.xlsx");

// Add the source workbook to the collection of external workbooks 
// and specify a custom name that can be used in external references instead of the file name.
workbook.ExternalWorkbooks.Add(sourceWorkbook, "MyExternalWorkbook");

// Create an external reference in the current workbook. 
worksheet["C3"].Formula = "=[MyExternalWorkbook]Sheet1!B3";
See Also