DiagramControl.CustomLoadDocument Event

Fires after an end-user selects a file in the ‘Open File’ dialog, or after a document load is initiated by setting the DiagramControl.DocumentSource property in code.

Namespace : DevExpress.XtraDiagram

Assembly : DevExpress.XtraDiagram.v25.2.dll

NuGet Package : DevExpress.Win.Diagram

csharp

[DiagramCategory(DiagramCategory.DiagramDocument)]
public event EventHandler<DiagramCustomLoadDocumentEventArgs> CustomLoadDocument

<DiagramCategory(DiagramCategory.DiagramDocument)>
Public Event CustomLoadDocument As EventHandler(Of DiagramCustomLoadDocumentEventArgs)

Event Data

The CustomLoadDocument event's data class is DevExpress.XtraDiagram.DiagramCustomLoadDocumentEventArgs.

Remarks

The CustomLoadDocument event allows you to implement custom logic for loading diagram data. The DocumentSource event parameter specifies the selected document supplier. If an end-user selected a file to be loaded in the ‘Open File’ dialog, the DocumentSource event parameter will specify the full path to the file. If a document load is initiated by setting the DiagramControl.DocumentSource property, the DocumentSource event parameter will match the DiagramControl.DocumentSource property value.

You can set the Handled event parameter to true to disable the default loading mechanism and implement custom load logic instead.