windowsforms-devexpress-dot-xtraspreadsheet-dot-spreadsheetcontrol-4ee6ee49.md
Provides access to a workbook loaded in the control.
Namespace : DevExpress.XtraSpreadsheet
Assembly : DevExpress.XtraSpreadsheet.v25.2.dll
NuGet Package : DevExpress.Win.Spreadsheet
[Browsable(false)]
public IWorkbook Document { get; }
<Browsable(False)>
Public ReadOnly Property Document As IWorkbook
| Type | Description |
|---|---|
| IWorkbook |
An object implementing the IWorkbook interface.
|
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.
using DevExpress.Spreadsheet;
// ...
// Access a workbook.
IWorkbook workbook = spreadsheetControl1.Document;
Imports DevExpress.Spreadsheet
' ...
' Access a workbook.
Dim workbook As IWorkbook = spreadsheetControl1.Document
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.
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-and-save-a-password-encrypted-files/CS/EncryptionExample/Form1.cs#L49
#region #SetEncryptionTypeAndPassword
IWorkbook workbook = spreadsheetControl1.Document;
workbook.DocumentSettings.Encryption.Type = (EncryptionType)Enum.Parse(typeof(EncryptionType), barEncryptionTypeComboBox.EditValue.ToString());
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-and-save-a-password-encrypted-files/VB/EncryptionExample/Form1.vb#L50
#Region "#SetEncryptionTypeAndPassword"
Dim workbook As IWorkbook = spreadsheetControl1.Document
workbook.DocumentSettings.Encryption.Type = CType([Enum].Parse(GetType(EncryptionType), barEncryptionTypeComboBox.EditValue.ToString()), EncryptionType)
See Also