Search
DiagramDocument Members
Constructors Properties Methods Events
 


Represents a collection of diagram pages.

The following tables list the members exposed by the DiagramDocument type.

 Public Constructors

  Name Description

DiagramDocument

Initializes a new instance of the DiagramDocument class.

 Public Properties

  Name Description

Dirty

Gets a value indicating whether the document has changed since the last save.

Pages

Gets a list of the diagram pages contained in this document.

 Public Methods

  Name Description

LoadFromFile

Loads the document from the specified file.

LoadFromStream

Loads the document from the specified stream.

LoadFromString

Loads the document from the specified string.

LoadFromXml

Overloaded. Loads the document from an XML document or file.

SaveToFile

Overloaded. Saves the document to a binary file.

SaveToStream

Overloaded. Saves the document into a stream.

SaveToString

Overloaded. Saves the document as an ASCII string.

SaveToXml

Overloaded. Saves the document to an XML document or file.

TrackMouseHover

Specifies whether the diagram view should track mouse hover events. (Inherited from DiagramBase.)

 Protected Methods

  Name Description

OnActionRecorded

Raises the ActionRecorded event. (Inherited from DiagramBase.)

OnActionRecording

Raises the ActionRecording event. (Inherited from DiagramBase.)

OnActionRedone

Raises the ActionRedone event. (Inherited from DiagramBase.)

OnActionUndone

Raises the ActionUndone event. (Inherited from DiagramBase.)

OnBeginLoad

Raises the BeginLoad event. (Inherited from DiagramBase.)

OnBoundsChanged

Raises the BoundsChanged event. (Inherited from DiagramBase.)

OnCellClicked

Raises the CellClicked event. (Inherited from DiagramBase.)

OnCellDoubleClicked

Raises the CellDoubleClicked event. (Inherited from DiagramBase.)

OnCellTextEdited

Raises the CellTextEdited event. (Inherited from DiagramBase.)

OnCellTextEditing

Raises the CellTextEditing event to validate entering inplace edit mode. (Inherited from DiagramBase.)

OnClicked

Raises the Clicked event. (Inherited from DiagramBase.)

OnContainerChildAdded

Raises the ContainerChildAdded event. (Inherited from DiagramBase.)

OnContainerChildRemoved

Raises the ContainerChildRemoved event. (Inherited from DiagramBase.)

OnContainerFolded

Raises the ContainerFolded event. (Inherited from DiagramBase.)

OnContainerUnfolded

Raises the ContainerUnfolded event. (Inherited from DiagramBase.)

OnContentVisibilityChanged

Raises the ContentVisibilityChanged event. (Inherited from DiagramBase.)

OnDefaultShapeChanged

Raises the DefaultShapeChanged event. (Inherited from DiagramBase.)

OnDeserializeTag

Raises the DeserializeTag event. (Inherited from DiagramBase.)

OnDestinationAnchorChanged

Raises the DestinationAnchorChanged event. (Inherited from DiagramBase.)

OnDirtyChanged

Raises the DirtyChanged event. (Inherited from DiagramBase.)

OnDoubleClicked

Raises the DoubleClicked event. (Inherited from DiagramBase.)

OnDrawAdjustmentHandles

Raises the DrawAdjustmentHandles event. (Inherited from DiagramBase.)

OnDrawAnchorPoint

Raises the DrawAnchorPoint event. (Inherited from DiagramBase.)

OnDrawBackground

Raises the DrawBackground event. (Inherited from DiagramBase.)

OnDrawBranchIndicator

Raises the DrawBranchIndicator event. (Inherited from DiagramBase.)

OnDrawCell

Raises the DrawCell event. (Inherited from DiagramBase.)

OnDrawForeground

Raises the DrawForeground event. (Inherited from DiagramBase.)

OnDrawLink

Raises the DrawLink event. (Inherited from DiagramBase.)

OnDrawNode

Raises the DrawNode event. (Inherited from DiagramBase.)

OnEndLoad

Raises the EndLoad event. (Inherited from DiagramBase.)

OnExpandButtonClicked

Raises the ExpandButtonClicked event. (Inherited from DiagramBase.)

OnGroupDestroyed

Raises the GroupDestroyed event. (Inherited from DiagramBase.)

OnHitTestAdjustmentHandles

Raises the HitTestAdjustmentHandles event. (Inherited from DiagramBase.)

OnInitializeLasso

Raises the InitializeLasso event. (Inherited from DiagramBase.)

OnInitializeLink

Raises the InitializeLink event. (Inherited from DiagramBase.)

OnInitializeNode

Raises the InitializeNode event. (Inherited from DiagramBase.)

OnItemAdded

Raises the ItemAdded event. (Inherited from DiagramBase.)

OnItemRemoved

Raises the ItemRemoved event. (Inherited from DiagramBase.)

OnJsonDeserializeTag

Raises the JsonDeserializeTag event. (Inherited from DiagramBase.)

OnJsonSerializeTag

Raises the JsonSerializeTag event. (Inherited from DiagramBase.)

OnLayerVisibilityChanged

Raises the LayerVisibilityChanged event. (Inherited from DiagramBase.)

OnLinkActivated

Raises the LinkActivated event. (Inherited from DiagramBase.)

OnLinkClicked

Raises the LinkClicked event. (Inherited from DiagramBase.)

OnLinkCreateCancelled

Raises the LinkCreateCancelled event. (Inherited from DiagramBase.)

OnLinkCreated

Raises the LinkCreated event. (Inherited from DiagramBase.)

OnLinkCreating

Raises the LinkCreating event. (Inherited from DiagramBase.)

OnLinkDeactivated

Raises the LinkDeactivated event. (Inherited from DiagramBase.)

OnLinkDeleted

Raises the LinkDeleted event. (Inherited from DiagramBase.)

OnLinkDeleting

Raises the LinkDeleting event. (Inherited from DiagramBase.)

OnLinkDeselected

Raises the LinkDeselected event. (Inherited from DiagramBase.)

OnLinkDoubleClicked

Raises the LinkDoubleClicked event. (Inherited from DiagramBase.)

OnLinkModified

Raises the LinkModified event. (Inherited from DiagramBase.)

OnLinkModifyCancelled

Raises the LinkModifyCancelled event. (Inherited from DiagramBase.)

OnLinkModifying

Raises the LinkModifying event. (Inherited from DiagramBase.)

OnLinkPasted

Raises the LinkPasted event. (Inherited from DiagramBase.)

OnLinkPointed

Raises the LinkPointed event. (Inherited from DiagramBase.)

OnLinkRouted

Raises the LinkRouted event. (Inherited from DiagramBase.)

OnLinkSelected

Raises the LinkSelected event. (Inherited from DiagramBase.)

OnLinkSelecting

Raises the LinkSelecting event. (Inherited from DiagramBase.)

OnLinkSplit

Raises the LinkSplit event. (Inherited from DiagramBase.)

OnLinkStartModifying

Raises the LinkStartModifying event. (Inherited from DiagramBase.)

OnLinkTextEdited

Raises the LinkTextEdited event. (Inherited from DiagramBase.)

OnLinkTextEditing

Raises the LinkTextEditing event to validate entering inplace edit mode. (Inherited from DiagramBase.)

OnMeasureUnitChanged

Raises the MeasureUnitChanged event. (Inherited from DiagramBase.)

OnNodeActivated

Raises the NodeActivated event. (Inherited from DiagramBase.)

OnNodeClicked

Raises the NodeClicked event. (Inherited from DiagramBase.)

OnNodeCreateCancelled

Raises the NodeCreateCancelled event. (Inherited from DiagramBase.)

OnNodeCreated

Raises the NodeCreated event. (Inherited from DiagramBase.)

OnNodeCreating

Raises the NodeCreating event. (Inherited from DiagramBase.)

OnNodeDeactivated

Raises the NodeDeactivated event. (Inherited from DiagramBase.)

OnNodeDeleted

Raises the NodeDeleted event. (Inherited from DiagramBase.)

OnNodeDeleting

Raises the NodeDeleting event. (Inherited from DiagramBase.)

OnNodeDeselected

Raises the NodeDeselected event. (Inherited from DiagramBase.)

OnNodeDoubleClicked

Raises the NodeDoubleClicked event. (Inherited from DiagramBase.)

OnNodeModified

Raises the NodeModified event. (Inherited from DiagramBase.)

OnNodeModifyCancelled

Raises the NodeModifyCancelled event. (Inherited from DiagramBase.)

OnNodeModifying

Raises the NodeModifying event. (Inherited from DiagramBase.)

OnNodePasted

Raises the NodePasted event. (Inherited from DiagramBase.)

OnNodePointed

Raises the NodePointed event. (Inherited from DiagramBase.)

OnNodeSelected

Raises the NodeSelected event. (Inherited from DiagramBase.)

OnNodeSelecting

Raises the NodeSelecting event. (Inherited from DiagramBase.)

OnNodeStartModifying

Raises the NodeStartModifying event. (Inherited from DiagramBase.)

OnNodeTextEdited

Raises the NodeTextEdited event. (Inherited from DiagramBase.)

OnNodeTextEditing

Raises the NodeTextEditing event to validate entering inplace edit mode. (Inherited from DiagramBase.)

OnOriginAnchorChanged

Raises the OriginAnchorChanged event. (Inherited from DiagramBase.)

OnQueryAlignTarget

Raises the QueryAlignTarget event. (Inherited from DiagramBase.)

OnRepaint

Raises the Repaint event. (Inherited from DiagramBase.)

OnRequestClipboard

Raises the RequestClipboard event. (Inherited from DiagramBase.)

OnRequestTimer

Raises the RequestTimer event. (Inherited from DiagramBase.)

OnSelectionChanged

Raises the SelectionChanged event. (Inherited from DiagramBase.)

OnSelectionModified

Raises the SelectionModified event. (Inherited from DiagramBase.)

OnSelectionModifying

Raises the SelectionModifying event. (Inherited from DiagramBase.)

OnSerializeTag

Raises the SerializeTag event. (Inherited from DiagramBase.)

OnSetSelfLoopShape

Raises the SetSelfLoopShape event. (Inherited from DiagramBase.)

OnShapeModified

Raises the ShapeModified event. (Inherited from DiagramBase.)

OnShapeNotDefined

Raises the ShapeNotDefined event. (Inherited from DiagramBase.)

OnTableColumnResized

Raises the TableColumnResized event. (Inherited from DiagramBase.)

OnTableColumnResizing

Raises the TableColumnResizing event. (Inherited from DiagramBase.)

OnTableRowResized

Raises the TableRowResized event. (Inherited from DiagramBase.)

OnTableRowResizing

Raises the TableRowResizing event. (Inherited from DiagramBase.)

OnTableSectionCollapsed

Raises the TableSectionCollapsed event. (Inherited from DiagramBase.)

OnTableSectionExpanded

Raises the TableSectionExpanded event. (Inherited from DiagramBase.)

OnTreeCollapsed

Raises the TreeCollapsed event. (Inherited from DiagramBase.)

OnTreeExpanded

Raises the TreeExpanded event. (Inherited from DiagramBase.)

OnTreeItemTextEditing

Raises the TreeItemTextEditing event. (Inherited from DiagramBase.)

OnValidateAnchorPoint

Raises the ValidateAnchorPoint event. (Inherited from DiagramBase.)

OnViewRemoved

Raises the ViewRemoved event. (Inherited from DiagramBase.)

 Public Events

  Name Description

ActionRecorded

Raised when an action is recorded in the undo buffer. (Inherited from DiagramBase.)

ActionRecording

A validation event raised before an action is recorded in the undo buffer. (Inherited from DiagramBase.)

ActionRedone

Raised when an action is redone. (Inherited from DiagramBase.)

ActionUndone

Raised when an action is undone. (Inherited from DiagramBase.)

ActiveLayerChanged

Raised when the diagram's active layer has changed. (Inherited from DiagramBase.)

BeginLoad

Raised when the component starts loading diagram data from a file or memory stream. (Inherited from DiagramBase.)

BoundsChanged

Raised when the Bounds property value has changed. (Inherited from DiagramBase.)

CellClicked

Raised when the user clicks a table’s cell. (Inherited from DiagramBase.)

CellDoubleClicked

Raised when the user double-clicks a table’s cell. (Inherited from DiagramBase.)

CellTextEdited

Raised when the user edits the text of a table’s cell. (Inherited from DiagramBase.)

CellTextEditing

A validation event that lets you approve or reject changes made to the text of a table’s cell. (Inherited from DiagramBase.)

Clicked

Raised when the user clicks the diagram at a point where no items are located. (Inherited from DiagramBase.)

ContainerChildAdded

Raised when a node is added to a ContainerNode, either programmatically or by the user. (Inherited from DiagramBase.)

ContainerChildRemoved

Raised when a node is removed from a ContainerNode, either programmatically or by the user. (Inherited from DiagramBase.)

ContainerFolded

Raised when the user folds a container by clicking the arrow-up button in the container's caption area. (Inherited from DiagramBase.)

ContainerUnfolded

Raised when the user unfolds a container by clicking the arrow-down button in the container's caption area. (Inherited from DiagramBase.)

ContentVisibilityChanged

Raised when the visibility of container's content changes. (Inherited from DiagramBase.)

DefaultShapeChanged

Raised when the DefaultShape property value has changed. (Inherited from DiagramBase.)

DeserializeTag

Raised when the Tag of a diagram item must be deserialized from XML format. (Inherited from DiagramBase.)

DestinationAnchorChanged

Raised when the DestinationAnchor property value of a link has changed. (Inherited from DiagramBase.)

DirtyChanged

Raised when the Dirty property value has changed. (Inherited from DiagramBase.)

DoubleClicked

Raised when the user double-clicks the diagram at a point where no items are located. (Inherited from DiagramBase.)

DrawAdjustmentHandles

Raised when item's adjustment handles must be custom-drawn. (Inherited from DiagramBase.)

DrawAnchorPoint

Raised when an anchor point must be custom-drawn. (Inherited from DiagramBase.)

DrawBackground

Raised to let you custom draw the diagram background. (Inherited from DiagramBase.)

DrawBranchIndicator

Raised when a branch indicator must be custom-drawn. (Inherited from DiagramBase.)

DrawCell

Raised when a table’s cell must be custom drawn. (Inherited from DiagramBase.)

DrawForeground

Raised to let you custom draw the diagram foreground. (Inherited from DiagramBase.)

DrawLink

Raised when a diagram link must be custom drawn. (Inherited from DiagramBase.)

DrawNode

Raised when a diagram node must be custom drawn. (Inherited from DiagramBase.)

EndLoad

Raised when the component ends loading diagram data from a file or memory stream. (Inherited from DiagramBase.)

ExpandButtonClicked

Raised when the user clicks the [±] button of an Expandable node. (Inherited from DiagramBase.)

GroupDestroyed

Raised when a Group object is destroyed. (Inherited from DiagramBase.)

HitTestAdjustmentHandles

Raised when custom hit testing of item’s adjustment handles must be performed. (Inherited from DiagramBase.)

InitializeLasso

Raised when the user starts drawing a selection lasso, before it is rendered on screen. (Inherited from DiagramBase.)

InitializeLink

Raised when the user starts drawing a new link, just after the DiagramLink instance is created. (Inherited from DiagramBase.)

InitializeNode

Raised when the user starts drawing a new node, just after the DiagramNode instance is created. (Inherited from DiagramBase.)

ItemAdded

Raised when an item is added to the diagram, either programmatically or interactively. (Inherited from DiagramBase.)

ItemRemoved

Raised when an item is removed from the diagram, either programmatically or interactively. (Inherited from DiagramBase.)

JsonDeserializeTag

Raised when the Tag of a diagram item must be deserialized from JSON. (Inherited from DiagramBase.)

JsonSerializeTag

Raised when the Tag of a diagram item must be serialized to JSON. (Inherited from DiagramBase.)

LayerVisibilityChanged

Raised when the visibility of a Layer changes. (Inherited from DiagramBase.)

LinkActivated

Raised when a link becomes the ActiveItem. (Inherited from DiagramBase.)

LinkClicked

Raised when the user clicks a link. (Inherited from DiagramBase.)

LinkCreateCancelled

Raised when the user cancels link creation. (Inherited from DiagramBase.)

LinkCreated

Raised when the user draws a new link. (Inherited from DiagramBase.)

LinkCreating

A validation event raised while the user is drawing a new link. (Inherited from DiagramBase.)

LinkDeactivated

Raised when a link is no longer the ActiveItem. (Inherited from DiagramBase.)

LinkDeleted

Raised when a link is deleted, either programmatically or by the user. (Inherited from DiagramBase.)

LinkDeleting

Raised when the user tries to delete a link, this event lets you cancel the operation. (Inherited from DiagramBase.)

LinkDeselected

Raised when a link is deselected, either programmatically or by the user. (Inherited from DiagramBase.)

LinkDoubleClicked

Raised when the user double-clicks a link. (Inherited from DiagramBase.)

LinkModified

Raised when the user moves any control point of a link. (Inherited from DiagramBase.)

LinkModifyCancelled

Raised when the user cancels move or resize operation being done on a link. (Inherited from DiagramBase.)

LinkModifying

A validation event raised while the user is modifying a link. (Inherited from DiagramBase.)

LinkPasted

Raised when a link has been pasted from the clipboard. (Inherited from DiagramBase.)

LinkPointed

Raised when the mouse pointer hovers over a link. (Inherited from DiagramBase.)

LinkRouted

Raised when a link is routed by the auto-routing algorithm. (Inherited from DiagramBase.)

LinkSelected

Raised when a link is selected, either programmatically or by the user. (Inherited from DiagramBase.)

LinkSelecting

Raised when the user tries to select a link, this event lets you cancel the operation. (Inherited from DiagramBase.)

LinkSplit

Raised when the user splits a link interactively. (Inherited from DiagramBase.)

LinkStartModifying

A validation event raised when the user starts modifying a link. (Inherited from DiagramBase.)

LinkTextEdited

Raised when the user edits the text of a link. (Inherited from DiagramBase.)

LinkTextEditing

A validation event that lets you approve or reject changes made to the text of a link. (Inherited from DiagramBase.)

MeasureUnitChanged

Raised when the MeasureUnit property value has changed. (Inherited from DiagramBase.)

NodeActivated

Raised when a node becomes the ActiveItem. (Inherited from DiagramBase.)

NodeClicked

Raised when the user clicks a node. (Inherited from DiagramBase.)

NodeCreateCancelled

Raised when the user cancels node creation. (Inherited from DiagramBase.)

NodeCreated

Raised when the user draws a new node. (Inherited from DiagramBase.)

NodeCreating

A validation event raised while the user is drawing a new node. (Inherited from DiagramBase.)

NodeDeactivated

Raised when a node is no longer the ActiveItem. (Inherited from DiagramBase.)

NodeDeleted

Raised when a node is deleted, either programmatically or by the user. (Inherited from DiagramBase.)

NodeDeleting

Raised when the user tries to delete a node, this event lets you cancel the operation. (Inherited from DiagramBase.)

NodeDeselected

Raised when a node is deselected, either programmatically or by the user. (Inherited from DiagramBase.)

NodeDoubleClicked

Raised when the user double-clicks a node. (Inherited from DiagramBase.)

NodeModified

Raised when the user moves or resizes a node. (Inherited from DiagramBase.)

NodeModifyCancelled

Raised when the user cancels move or resize operation being done on a node. (Inherited from DiagramBase.)

NodeModifying

A validation event raised while the user is moving or resizing a node. (Inherited from DiagramBase.)

NodePasted

Raised when a node has been pasted from the clipboard. (Inherited from DiagramBase.)

NodePointed

Raised when the mouse pointer hovers over a node. (Inherited from DiagramBase.)

NodeSelected

Raised when a node is selected, either programmatically or by the user. (Inherited from DiagramBase.)

NodeSelecting

Raised when the user tries to select a node, this event lets you cancel the operation. (Inherited from DiagramBase.)

NodeStartModifying

A validation event raised when the user starts modifying a node. (Inherited from DiagramBase.)

NodeTextEdited

Raised when the user edits the text of a node. (Inherited from DiagramBase.)

NodeTextEditing

A validation event that lets you approve or reject changes made to the text of a node. (Inherited from DiagramBase.)

OriginAnchorChanged

Raised when the OriginAnchor property value of a link has changed. (Inherited from DiagramBase.)

QueryAlignTarget

Raised to validate a node as target for alignment guides when AutoAlignNodes is enabled. (Inherited from DiagramBase.)

Repaint

Raised when the diagram views should be repainted. (Inherited from DiagramBase.)

RequestCacheReset

Raised when an object within the diagram requests a reset of the cached bitmap. (Inherited from DiagramBase.)

RequestClipboard

Raised when an object within the diagram requests an operation with the clipboard. (Inherited from DiagramBase.)

RequestTimer

Raised when an object within the diagram needs to start or stop a timer. (Inherited from DiagramBase.)

SelectionChanged

Raised when an item is added to or removed from the selection (Inherited from DiagramBase.)

SelectionModified

Raised when the user moves multiple selected items. (Inherited from DiagramBase.)

SelectionModifying

Raised while the user is moving multiple selected items, this event lets you cancel the modification. (Inherited from DiagramBase.)

SerializeTag

Raised when the Tag of a diagram item must be serialized into an XML document. (Inherited from DiagramBase.)

SetSelfLoopShape

Raised when a link becomes a self-loop, giving you a chance to override the default look shape. (Inherited from DiagramBase.)

ShapeModified

Raised when the user modifies the shape of a ShapeNode by moving one of the control points corresponding to shape formula parameters. (Inherited from DiagramBase.)

ShapeNotDefined

Raised when the diagram being loaded contains nodes with an undefined shape. (Inherited from DiagramBase.)

TableColumnResized

Raised when the user finishes resizing a column in a table. (Inherited from DiagramBase.)

TableColumnResizing

Raised when the user resizes a column in a table interactively. (Inherited from DiagramBase.)

TableRowResized

Raised when the user finishes resizing a row in a table. (Inherited from DiagramBase.)

TableRowResizing

Raised when the user resizes a row in a table interactively. (Inherited from DiagramBase.)

TableSectionCollapsed

Raised when the user collapses the rows of a table’s section by clicking the [-] button in the section's header row. (Inherited from DiagramBase.)

TableSectionExpanded

Raised when the user expands the rows of a table's section by clicking the [+] button in the section’s header row. (Inherited from DiagramBase.)

TreeCollapsed

Raised when a user collapses a tree branch by clicking the [-] button of an Expandable node. (Inherited from DiagramBase.)

TreeExpanded

Raised when a user expands a tree branch by clicking the [+] button of an Expandable node. (Inherited from DiagramBase.)

TreeItemTextEditing

A validation event that lets you approve or reject changes made to the text of a TreeViewNode's item. (Inherited from DiagramBase.)

ValidateAnchorPoint

A validation event that lets you approve or reject connecting a link to an anchor point. (Inherited from DiagramBase.)

ViewRemoved

Raised when a DiagramView is detached from this diagram. (Inherited from DiagramBase.)

 See Also