SnapControl.DocumentLoaded Event

Occurs before loading a SnapDocument into a SnapControl.

Namespace: DevExpress.Snap

Assembly: DevExpress.Snap.v18.2.dll

Declaration

C#

public event DocumentImportedEventHandler DocumentLoaded

VB.NET

Public Event DocumentLoaded As DocumentImportedEventHandler

Event Data

The DocumentLoaded event's data class is DocumentImportedEventArgs. The following properties provide information specific to this event:

Property	Description
Handled	Specifies whether or not the corresponding event of the SnapControl was handled.
InterimDataSources	Provides access to the interim document data sources that have been created by an end-user during a document editing session.

Remarks

Handle this event to obtain interim document data sources that have been created by an end-user (e.g., to save them for another document editing session) via the DocumentImportedEventArgs.InterimDataSources property.

Related GitHub Examples

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.

C#

how-to-generate-and-send-e-mails-bulk-mail-while-iterating-through-datasource-records-e5006/CS/Form1.cs#L49

private void SendLetters() {
    snapControl1.DocumentLoaded += new DevExpress.Snap.DocumentImportedEventHandler(snapControl1_Letter_DocumentLoaded);
    CurrentEmailIndex = 0;

how-to-generate-a-live-report-based-on-gridcontrol-content-t272175/CS/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.cs#L30

SnapReport.DocumentLoaded += SnapReport_DocumentLoaded;
SnapReport.CreateNewDocument();

VB.NET

how-to-generate-and-send-e-mails-bulk-mail-while-iterating-through-datasource-records-e5006/VB/Form1.vb#L51

Private Sub SendLetters()
    AddHandler snapControl1.DocumentLoaded, AddressOf snapControl1_Letter_DocumentLoaded
    CurrentEmailIndex = 0

how-to-generate-a-live-report-based-on-gridcontrol-content-t272175/VB/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.vb#L32

AddHandler SnapReport.DocumentLoaded, AddressOf SnapReport_DocumentLoaded
SnapReport.CreateNewDocument()