Search
Diagram Methods
 


 Public Methods

  Name Description

AlignPointToGrid

Returns a point of the alignment grid nearest to the one passed as an argument.

Arrange

Arranges the diagram using the specified graph layout algorithm.

ArrangeAnimated

Arranges the diagram using the specified graph layout algorithm, and animates items moving to their new positions.

ArrangeAsync

Arranges the diagram asynchronously using the specified graph layout algorithm.

ArrangeLinkLabels

Rearranges link labels whose AutoArrange property is enabled.

ChangeUnit

Sets new MeasureUnit value and scales the coordinates of diagram items so that their absolute size remains unchanged.

ClearAll

Removes all items from the diagram.

CopySelection

Creates a copy of the currently selected objects and groups.

CreateImage

Overloaded. Creates a bitmap containing an image of the diagram.

CreateMeasureGraphics

Creates an IGraphics object that can be used to obtain various string size measurements.

CreateThemeFromDefaults

Creates a Theme object representing the default properties of the diagram.

Draw

Renders the diagram on the specified IGraphics object.

DrawAlignmentGuides

Draws the current alignment guides.

DrawInteraction

Draws the items that the user is currently modifying.

DrawLayer

Renders all diagram items to the specified graphics.

DrawStyledText

Draws a formatted text string, the same way text is drawn in shape nodes whose EnableStyledText property is set to true. This method lets you display styled text in custom-drawn nodes or links.

EnumByReverseZ

Hit-tests diagram items in reverse Z order.

EnumTopLevelByReverseZ

Hit-tests diagram top-level items in reverse Z order.

ExecuteCommand

Executes the specified command on this diagram.

FindGroup

Finds the group that has the specified tag value.

FindLink

Finds the link that has the specified tag value.

FindLinkById

Finds the link that has the specified id value.

FindNode

Finds the node that has the specified tag value.

FindNodeById

Finds the node that has the specified id value.

GetContentBounds

Returns the smallest rectangle that bounds all diagram objects.

GetItemAt

Finds and returns the top-most diagram item that lies at the specified location.

GetLinkAt

Overloaded. Finds and returns the link that lies at the specified location.

GetLinksAt

Returns the links that contain the specified point.

GetNearestNode

Returns the node nearest to the specified point.

GetNodeAt

Overloaded. Gets the node that lies at the specified location.

GetNodesAt

Returns the nodes that contain the specified point.

GetNodesInViewport

Returns all nodes visible in the current viewport.

HandleKeyDown

Propagates keyboard input to interested manipulators and components.

HandleKeyPress

Propagates keyboard input to interested manipulators.

HandleKeyUp

Propagates keyboard input to interested components.

HandleMouseMove

Propagates mouse input to interested manipulators.

HitTestComponents

Tests whether the specified point is within a component of a diagram item and returns this component.

HitTestLabels

Returns the item label located at specified position.

HitTestManipulators

Tests whether the specified point is within the manipulator of a diagram object and triggers the manipulator.

Invalidate

Overloaded. Invalidates the diagram or a region of the diagram, causing it to be repainted.

InvalidateZOrder

Forces a new sort of the Z order list before next redraw.

IsClassRegistered

Checks if a class is registered for serialization support.

IsClientClassRegistered

Checks if a class is registered for JSON serialization support.

IsItemInteractive

Checks if the specified item can be modified interactively.

IsItemLocked

Checks if the specified item is locked.

IsItemVisible

Checks if the specified item is currently visible.

LoadFromFile

Loads the contents of an existing diagram file into the control.

LoadFromJson

Loads the diagram from a JSON-formatted string.

LoadFromJsonFile

Loads the diagram from a JSON file.

LoadFromJsonObject

Loads the diagram from a JSON object.

LoadFromStream

Loads a diagram from the specified stream.

LoadFromString

Decodes diagram contents from a string that was created with SaveToString.

LoadFromXml

Overloaded. Loads the contents of an XML diagram document into the control.

MeasureString

Overloaded. Measures a text taking into consideration the current affine transform of the diagram.

Navigate

Selects the nearest item in the specified direction.

NewInstance

Custom Diagram classes must override this method to return an instance of their type.

PasteSelection

Adds the specified items and groups to the specified diagram document.

PixelToUnit

Converts the specified point from client to document coordinates ignoring the current scale transformation.

RaiseCellTextEdited

Raises the CellTextEdited event .

RaiseCellTextEditing

Raises the CellTextEditing event to validate entering in-place editing mode.

RaiseClicked

Overloaded. Raises the Clicked event of the diagram or one of the *Clicked events related to diagram items.

RaiseCreated

Raises the appropriate *Created event according to the type of the specified item.

RaiseDeleting

Raises the appropriate *Deleting event according to the type of the specified item.

RaiseDoubleClicked

Overloaded. Raises the DoubleClicked event of the diagram or one of the *DoubleClicked events related to diagram items.

RaiseLinkTextEdited

Raises the LinkTextEdited event.

RaiseLinkTextEditing

Raises the LinkTextEditing event to validate entering inplace edit mode.

RaiseMouseHover

Raises the appropriate Pointed event.

RaiseNodeTextEdited

Raises the NodeTextEdited event.

RaiseNodeTextEditing

Raises the NodeTextEditing event to validate entering inplace edit mode.

RaisePasted

Raises the appropriate Pasted event.

RaiseSelecting

Raises the appropriate Selecting event.

RaiseTreeItemTextEditing

Raises the TreeItemTextEditing event to validate entering inplace edit mode.

RaiseViewRemoved

Raises the ViewRemoved event.

RegisterClass

Overloaded.  

RegisterDefaultStyle

Registers a default style for the objects of the specified type.

RegisterItemClass

Overloaded.  

ResetAlignmentGuides

For internal use.

ResizeToFitItem

Resizes the document extents so that the specified item is contained within.

ResizeToFitItems

Overloaded. Resizes the document scrollable area so it fits all diagram items.

ResumeLinkRouter

Called when the control ends a batch update operation that might affect many links.

RouteAllLinks

Overloaded.  

SaveToFile

Overloaded. Saves the binary contents of the diagram to a disk file.

SaveToJson

Saves the diagram to a JSON-formatted string.

SaveToJsonFile

Saves the diagram into a JSON file.

SaveToJsonObject

Saves the diagram to a JSON object.

SaveToStream

Overloaded. Saves the binary contents of the diagram to a .NET stream.

SaveToString

Overloaded. Encodes the diagram contents into an ASCII string.

SaveToXml

Overloaded. Saves the diagram to an XML document.

SetShadowOffset

Sets the default offset at which items shadows are drawn.

SuspendLinkRouter

Called when the control starts a batch update operation that might affect many links. Implementations might collect the links specified through RouteLink and RouteLinks calls and defer finding their paths for when ResumeLinkRouter is called.

TrackMouseHover

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

TryLoadCorruptedFile

Loads a diagram from the specified file.

UnitToPixel

Converts the specified point from document to client coordinates ignoring the current scale transformation.

UpdateMeasureTextScale

Gets or sets the scale to use when measuring texts. This should be effectively set to the value of DiagramView.Zoom / 100.

UpdateRuntimeIndices

For internal use.

UpdateZOrder

Immediately sorts the Z-order list if Z-order has been invalidated. Otherwise it will be sorted next time the diagram draws its contents.

 Protected Methods

  Name Description

AddItem

Invoked by the AddItemCmd and RemoveItemCmd classes to effectively add the specified item to the diagram.

CreateAddItemCmd

Creates an AddItemCmd instance that implements undo/redo of adding an item to the diagram.

CreateItem

Creates an instance of the specified class.

CreateModifyItemCmd

Creates a ModifyItemCmd instance that implements undo/redo of item move and resize operations.

CreateRemoveItemCmd

Creates a RemoveItemCmd instance that implements undo/redo of removing an item from the diagram.

DeleteGroup

Removes the specified group from the group collection.

Dispose

Clean up any resources being used.

GetValue

Gets the effective value of the style property with the specified name.

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

RemoveItem

Invoked by the AddItemCmd and RemoveItemCmd classes to effectively remove the specified item from the diagram.

 See Also