Back to Devexpress

SpreadsheetControl.DocumentLoaded Event

windowsforms-devexpress-dot-xtraspreadsheet-dot-spreadsheetcontrol-56d91fb7.md

latest4.6 KB
Original Source

SpreadsheetControl.DocumentLoaded Event

Occurs after a document is loaded into the Spreadsheet control.

Namespace : DevExpress.XtraSpreadsheet

Assembly : DevExpress.XtraSpreadsheet.v25.2.dll

NuGet Package : DevExpress.Win.Spreadsheet

Declaration

csharp
public event EventHandler DocumentLoaded
vb
Public Event DocumentLoaded As EventHandler

Event Data

The DocumentLoaded event's data class is EventArgs.

Remarks

The DocumentLoaded event fires after the LoadDocument method of the SpreadsheetControl or IWorkbook object is executed. It occurs when the document model is built and the loaded document is valid. Handle this event to ensure that a document is loaded completely and you can safely modify it.

The example below shows how to use the DocumentLoaded event to recalculate all formulas in the loaded document.

csharp
spreadsheetControl.DocumentLoaded += SpreadsheetControl_DocumentLoaded;
// ...

private void SpreadsheetControl_DocumentLoaded(object sender, System.EventArgs e)
{
    spreadsheetControl.Document.CalculateFull();
}
vb
AddHandler spreadsheetControl.DocumentLoaded, AddressOf SpreadsheetControl_DocumentLoaded
' ...

Private Sub SpreadsheetControl_DocumentLoaded(sender As Object, e As EventArgs)
    spreadsheetControl.Document.CalculateFull()
End Sub

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

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-use-formula-engine/CS/FormulaEngineTest/Form1.cs#L25

csharp
SetCellContext();
spreadsheetControl1.DocumentLoaded += spreadsheetControl1_DocumentLoaded;
spreadsheetControl1.ActiveCell.Formula = "SUM(R[1]C:R[2]C)";

winforms-spreadsheet-assign-custom-in-place-editors/CS/Spreadsheet_CustomCellEditors/Form1.cs#L15

csharp
spreadsheetControl.DocumentLoaded += spreadsheetControl1_DocumentLoaded;
#region #CustomCellEdit

winforms-spreadsheet-use-formula-engine/VB/FormulaEngineTest/Form1.vb#L24

vb
SetCellContext()
AddHandler spreadsheetControl1.DocumentLoaded, AddressOf spreadsheetControl1_DocumentLoaded
spreadsheetControl1.ActiveCell.Formula = "SUM(R[1]C:R[2]C)"

winforms-spreadsheet-assign-custom-in-place-editors/VB/Spreadsheet_CustomCellEditors/Form1.vb#L14

vb
spreadsheetControl.LoadDocument("Documents\Document.xlsx", DocumentFormat.Xlsx)
            AddHandler spreadsheetControl.DocumentLoaded, AddressOf spreadsheetControl1_DocumentLoaded
#Region "#CustomCellEdit"

See Also

How to: Load a Document into SpreadsheetControl

SpreadsheetControl Class

SpreadsheetControl Members

DevExpress.XtraSpreadsheet Namespace