SpreadsheetControl.Document Property

Provides access to a workbook loaded in the control.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v24.1.dll

NuGet Package: DevExpress.Win.Spreadsheet

Declaration

C#

[Browsable(false)]
public IWorkbook Document { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property Document As IWorkbook

Property Value

Type	Description
IWorkbook	An object implementing the IWorkbook interface.

Example

To programmatically modify a workbook loaded in the SpreadsheetControl, access the object implementing the IWorkbook interface via the SpreadsheetControl.Document property. This object is the starting point for using the SpreadsheetControl API.

C#

using DevExpress.Spreadsheet;
// ...

// Access a workbook.
IWorkbook workbook = spreadsheetControl1.Document;

VB.NET

Imports DevExpress.Spreadsheet
' ...

' Access a workbook.
Dim workbook As IWorkbook = spreadsheetControl1.Document

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Document property.

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#

winforms-spreadsheet-chart-api/CS/SpreadsheetChartAPISamples/Form1.cs#L112

{
    IWorkbook workbook = spreadsheet.Document;
    foreach (Worksheet sheet in workbook.Worksheets)

winforms-spreadsheet-pivot-table-api/CS/SpreadsheetPivotTableExamples/Form1.cs#L101

{
    IWorkbook workbook = spreadsheet.Document;
    foreach (Worksheet sheet in workbook.Worksheets)

winforms-spreadsheetcontrol-api-part-3/CS/SpreadsheetControl_API_Part03/Form1.cs#L370

{
    IWorkbook document = spreadsheetControl.Document;
    document.BeginUpdate();

winforms-spreadsheet-mail-merge/CS/DXApplication1/Form1.cs#L23

spreadsheetControl1.LoadDocument("Documents\\MailMergeTemplate.xlsx");
template = spreadsheetControl1.Document;
template.MailMergeDataSource = dataSet;

winforms-spreadsheet-load-an-ms-access-database-file-into-the-document/CS/WindowsFormsApplication1/MSAccessImportHelper.cs#L75

IDocumentImportManagerService service = (IDocumentImportManagerService)spreadSheet.GetService(typeof(IDocumentImportManagerService));
CustomDocumentImportManagerService customService = new CustomDocumentImportManagerService(spreadSheet.Document);
spreadSheet.ReplaceService<IDocumentImportManagerService>(customService);

VB.NET

winforms-spreadsheet-chart-api/VB/SpreadsheetChartAPISamples/Form1.vb#L107

Private Sub evaluator_OnAfterCompile(ByVal sender As Object, ByVal args As OnAfterCompileEventArgs)
    Dim workbook As IWorkbook = spreadsheet.Document
    For Each sheet As Worksheet In workbook.Worksheets

winforms-spreadsheet-pivot-table-api/VB/SpreadsheetPivotTableExamples/Form1.vb#L95

Private Sub evaluator_OnAfterCompile(ByVal sender As Object, ByVal args As OnAfterCompileEventArgs)
    Dim workbook As IWorkbook = spreadsheet.Document
    For Each sheet As Worksheet In workbook.Worksheets

winforms-spreadsheetcontrol-api-part-3/VB/SpreadsheetControl_API_Part03/Form1.vb#L358

Private Sub evaluator_OnBeforeCompile(ByVal sender As Object, ByVal e As EventArgs)
    Dim document As IWorkbook = spreadsheetControl.Document
    document.BeginUpdate()

winforms-spreadsheet-mail-merge/VB/DXApplication1/Form1.vb#L23

spreadsheetControl1.LoadDocument("Data\MailMergeTemplate.xlsx")
template = spreadsheetControl1.Document
template.MailMergeDataSource = dataSet

winforms-spreadsheet-load-an-ms-access-database-file-into-the-document/VB/WindowsFormsApplication1/MSAccessImportHelper.vb#L95

Dim service As IDocumentImportManagerService = CType(spreadSheet.GetService(GetType(IDocumentImportManagerService)), IDocumentImportManagerService)
Dim customService As New CustomDocumentImportManagerService(spreadSheet.Document)
spreadSheet.ReplaceService(Of IDocumentImportManagerService)(customService)