DiagramControl.SaveDocument(Stream) Method

Saves the current diagram document to a stream.

Namespace: DevExpress.Xpf.Diagram

Assembly: DevExpress.Xpf.Diagram.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Diagram, DevExpress.Wpf.Diagram

Declaration

C#

public void SaveDocument(
    Stream stream
)

VB.NET

Public Sub SaveDocument(
    stream As Stream
)

Parameters

Name	Type	Description
stream	Stream	A stream to which to save the diagram document.

Remarks

A diagram can be saved to an XML file and then loaded from this file at design time and runtime.

Use the DiagramControl.LoadDocument method to load a diagram from a file.

Handle the DiagramControl.CustomSaveDocument and DiagramControl.CustomLoadDocument events to implement custom logic for loading and saving diagrams.

The DiagramContentItem.Content property that defines items with custom content is serialized by default, provided that its content supports serialization. Simple types are supported out of the box. Custom types should be marked with the SerializableAttribute. See the Value types article in MSDN.

To enable serialization for custom item types, use the DevExpress.Diagram.Core.DiagramItemTypeRegistrator.Register method. To modify the list of serialized properties, use the DiagramControl.CustomGetSerializableItemProperties event. Alternatively, mark the additional properties of a custom item type with the DevExpress.Utils.Serializing.XtraSerializableProperty attribute.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SaveDocument(Stream) method.

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-handle-diagramcontrol-events-to-save-diagrams-to-a-database-instead-of-a-file-system-t329840/CS/DXDiagram.CustomDiagramStorage/DiagramStorageInitializer.cs#L28

using(var stream = new MemoryStream()) {
    diagram.SaveDocument(stream);
    var diagramData = new DiagramData() {

VB.NET

how-to-handle-diagramcontrol-events-to-save-diagrams-to-a-database-instead-of-a-file-system-t329840/VB/DXDiagram.CustomDiagramStorage/DiagramStorageInitializer.vb#L26

Using stream = New MemoryStream()
    diagram.SaveDocument(stream)
    Dim diagramData = New DiagramData() With {.Name = (i + 1).ToString() & " items", .Data = stream.ToArray()}