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 or sets a value indicating whether the diagram document has changed since loading it.

pages

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

 Public Methods

  Name Description

addPage

Adds a page to the document.

fromJson

Deserializes the document from a JSON string.

fromXmlDocument

Loads document contents from specified XML Document.

loadFromString

Loads document contents from specified XML or JSON string.

loadFromXml

Loads the document from an XML file.

raiseClicked

Raises an event which notifies that a Diagram item has been clicked. (Inherited from DiagramBase.)

raiseCreated

Raises an event which notifies that a Diagram item has been created. (Inherited from DiagramBase.)

raiseDeleted

Raises an event which notifies that a Diagram item has been deleted. (Inherited from DiagramBase.)

raiseDeselected

Raises an event which notifies that a Diagram item has been deselected. (Inherited from DiagramBase.)

raiseDoubleClicked

Raises an event which notifies that a Diagram item has been double-clicked. (Inherited from DiagramBase.)

raiseModified

Raises an event which notifies that a Diagram item has been modified. (Inherited from DiagramBase.)

raisePasted

Raises an event which notifies that a Diagram item has been pasted from clipboard. (Inherited from DiagramBase.)

raiseSelected

Raises an event which notifies that a Diagram item has been selected. (Inherited from DiagramBase.)

raiseSelecting

Raises an event which notifies that a Diagram item will be selected. (Inherited from DiagramBase.)

raiseSelectingAsync

Raises an event which notifies that a Diagram item will be selected. (Inherited from DiagramBase.)

raiseSelectionChanged

Raises an event which notifies that the selection has changed. (Inherited from DiagramBase.)

removePage

Removes the specified page from the document.

saveToString

Encodes the document contents into an XML or JSON string.

saveToXml

Saves the document to an XML file.

toJson

Serializes the document into a JSON string.

toXmlDocument

Saves the document into an XML Document.

 Public Events

  Name Description

animatedLayoutCompleted

Raised when an animated layout completes. (Inherited from DiagramBase.)

cellTextEdited

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

cellTextEditing

Raised when the user starts to edit the text of a table 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 the user adds a node to a ContainerNode. (Inherited from DiagramBase.)

containerChildAdding

A validation event raised to let you prevent users from adding child nodes to a container. (Inherited from DiagramBase.)

containerChildRemoved

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

containerChildRemoving

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

containerFolded

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

containerUnfolded

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

dataLoaded

Raised when the diagram data is loaded. (Inherited from DiagramBase.)

deserializeTag

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

drawAdjustmentHandles

Raised to draw custom adjustment handles. (Inherited from DiagramBase.)

drawAnchorPoint

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

expandButtonClicked

Raised if expandButtonAction is set to RaiseEvents and the [+/-]button of an expandable node is clicked. (Inherited from DiagramBase.)

headerResized

Raised when the user finished resizing a header. (Inherited from DiagramBase.)

headerStartResizing

Raised when the user starts resizing a header. (Inherited from DiagramBase.)

hitTestAdjustmentHandles

Raised to hit-test custom adjustment handles. (Inherited from DiagramBase.)

hyperlinkClicked

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

initializeLink

Raised when the user removes a node from a ContainerNode. (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. (Inherited from DiagramBase.)

itemRemoved

Raised when an item is removed from the diagram. (Inherited from DiagramBase.)

laneGridCellTextEdited

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

linkClicked

Raised when the user clicks a link. (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.)

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.)

linkHovered

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

linkModified

Raised when the user moves any control point of 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.)

linkPointerEnter

Raised when the mouse pointer enters the boundaries of a link. (Inherited from DiagramBase.)

linkPointerLeave

Raised when the mouse pointer leaves the boundaries of 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.)

linkTextEdited

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

linkTextEditing

Raised when the user starts to edit the text of a link. (Inherited from DiagramBase.)

nodeClicked

Raised when the user clicks a node. (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.)

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.)

nodeDomCreated

Raised when the content of a ControlNode is added to the page DOM. (Inherited from DiagramBase.)

nodeDoubleClicked

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

nodeHovered

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

nodeModified

Raised when the user moves or resizes 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.)

nodePointerEnter

Raised when the mouse pointer enters the boundaries of a node. (Inherited from DiagramBase.)

nodePointerLeave

Raised when the mouse pointer leaves the boundaries of 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.)

nodeTextEdited

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

nodeTextEditing

Raised when the user starts to edit the text of a node. (Inherited from DiagramBase.)

queryView

Raised to enumerate diagram views. (Inherited from DiagramBase.)

selectionChanged

Raised when the diagram selection has changed. (Inherited from DiagramBase.)

selectionModifying

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

serializeTag

Raised when the Tag or Id of a diagram item must be serialized in XML format. (Inherited from DiagramBase.)

sizeChanged

Raised when the size of the diagram canvas has changed. (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 a table section is collapsed. (Inherited from DiagramBase.)

tableSectionExpanded

Raised when a table section is expanded. (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.)

treeItemTextEdited

Raised when the user edits the text of a tree view item. (Inherited from DiagramBase.)

treeItemTextEditing

Raised when the user starts to edit the text of a tree view item. (Inherited from DiagramBase.)

validateAnchorPoint

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

validateLinkCrossing

A validation event that lets you approve or reject displaying a decoration at the intersection point of links. (Inherited from DiagramBase.)

 See Also