ExternalWorkbookCollection.Add(ExternalWorkbook, String) Method

Adds a new workbook to the ExternalWorkbookCollection collection.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

void Add(
    ExternalWorkbook item,
    string alias
)

VB.NET

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.

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.

C#

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";

VB.NET

Imports DevExpress.Spreadsheet
' ...

' Access the current workbook where you wish to use external references. 
Private workbook As IWorkbook = spreadsheetControl1.Document
Private worksheet As Worksheet = workbook.Worksheets(0)

' Access the source workbook that contains cells to be referred to from the current workbook. 
Private sourceWorkbook As IWorkbook = 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"