NetDiagram Programmer's Guide
DiagramView Members
Constructors Properties Methods Events
 


Renders the contents of a Diagram on a web page.

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

 Public Constructors

  Name Description

DiagramView

Initializes a new instance of the DiagramView class.

 Public Properties

  Name Description

AllowInplaceEdit

Gets or sets a value indicating whether in-place editing of the text of objects is enabled.

AnimatedLayoutCompletedScript

Contains the name of a JavaScript function that should be invoked when an animated layout completes.

AppletElement

Returns a JavaScript statement that returns a reference to the NetDiagram applet.

AutoClasses

Gets the registered client types with JSON templates.

AutoPostBack

Gets or sets a value indicating whether the control automatically posts back to the server when the user interacts with it.

AutoScroll

Gets or sets a value indicating whether auto scrolling of the document area is enabled.

Behavior

Gets or sets a value indicating how the control responds to user actions.

CanvasVirtualScroll

Gets or sets a value indicating whether Canvas virtual scroll mode is enabled.

CellTextEditedScript

Contains the name of a JavaScript function that should be invoked when the user edits the text of a table's cell.

ClickedScript

Contains the name of a JavaScript function that should be invoked when the user clicks on a location unoccupied by diagram elements.

ClientFocus

Gets or sets if the DiagramView has the keyboard focus in ImageMap mode.

ClientScriptMode

Gets or sets a value indicating which library will be used in the control's client-side scripts in Canvas ClientSideMode.

ClientSideMode

Specifies the method used for handling user interaction and drawing on the client side.

ContainerChildAddedScript

Contains the name of a JavaScript function that should be invoked when a node is added to a ContainerNode.

ContainerChildAddingScript

Contains the name of a JavaScript function that should be invoked before a child node is added to a container.

ContainerChildRemovedScript

Contains the name of a JavaScript function that should be invoked when a node is removed from a ContainerNode.

ContainerChildRemovingScript

Contains the name of a JavaScript function that should be invoked before a child node is removed from a container.

ContainerFoldedScript

Contains the name of a JavaScript function that should be invoked when the user folds a container by clicking the arrow-up button in the container's caption area.

ContainerUnfoldedScript

Contains the name of a JavaScript function that should be invoked when the user unfolds a container by clicking the arrow-down button in the container's caption area.

ControlLoadedScript

Contains the name of a JavaScript function that should be invoked when the control is loaded on the client side.

Converters

Gets the registered custom converters.

CreateEditControlScript

Contains the name of a JavaScript function that should be invoked when in-place edit operation starts, letting you create a custom editor control instead of TEXTAREA.

CustomLinkType

Gets or sets the type of a MindFusion.Diagramming.DiagramLink derived class whose instance should be created when a user starts drawing.

CustomNodeType

Gets or sets the type of a MindFusion.Diagramming.DiagramNode derived class whose instance should be created when a user starts drawing.

DefaultControlTemplate

Gets or sets the HTML string representing the DOM content, rendered by default in newly created ControlNode objects.

DelKeyAction

Gets or sets a value that specifies what action should be performed when the user hits the Del key.

DeserializeTagScript

Contains the name of a JavaScript function that should be invoked when custom data associated with a diagram item comes from the server to the browser and must be decoded from its string representation.

Diagram

Gets the diagram displayed by this view.

DrawAdjustmentHandlesScript

Contains the name of a JavaScript function that should be invoked when itemís adjustment handles must be custom drawn.

EnableClipboard

Enables copy, paste and cut operations in ImageMap client mode.

EnableItemsDOM

Enables items DOM in ImageMap client mode.

EnterInplaceEditScript

Contains the name of a JavaScript function that should be invoked when when entering the in-place editing mode.

Focusable

Gets or sets whether the control should request the keyboard focus when clicked.

HeaderResizedScript

Contains the name of a JavaScript function that should be invoked when the user resizes a header.

HeaderStartResizingScript

Contains the name of a JavaScript function that should be invoked when the user starts resizing a header interactively.

HitTestAdjustmentHandlesScript

Contains the name of a JavaScript function that should be invoked when custom hit testing of itemís adjustment handles must be performed.

HyperlinkClickedScript

Contains the name of a JavaScript function that should be invoked when the user clicks a hyperlink inside a node.

ImageFormat

Gets or sets the format of the generated images. It must be specified as a MIME type string.

ImageGenArguments

Custom query string that should be appended to the ImageGen's url.

ImageGenLocation

URL to the ImageGen.ashx file used to generate diagram images. This property is rendered as a SRC attribute for the diagram's IMG image element.

ImageQuality

Gets or sets the quality of compressed images. Accepted values are between 1 and 100. A greater value yields an image of higher quality, but with lower compression.

InitializeLinkScript

Contains the name of a JavaScript function that should be invoked when the user starts drawing a new link, just after the DiagramLink instance is created.

InitializeNodeScript

Contains the name of a JavaScript function that should be invoked when the user starts drawing a new node, just after the DiagramNode instance is created.

ItemAddedScript

Contains the name of a JavaScript function that should be invoked when an item is added to the diagram.

ItemRemovedScript

Contains the name of a JavaScript function that should be invoked when an item is removed from the diagram.

ItemTypes

Gets the registered item types.

JQueryLocation

Gets or sets the URL to the JQuery script file.

JsLibraryLocation

Gets or sets the URL to the MindFusion.Diagramming.js file, used in Canvas ClientSideMode.

LaneGridCellTextEditedScript

Contains the name of a JavaScript function that should be invoked when the used edits the text of a grid cell.

LeaveInplaceEditScript

Contains the name of a JavaScript function that should be invoked when when leaving the in-place editing mode.

LicenseKey

Gets or sets the license key of the control.

LinkClickedScript

Contains the name of a JavaScript function that should be invoked when the users clicks a link.

LinkCreatedScript

Contains the name of a JavaScript function that should be invoked when the user draws a new link.

LinkCreatingScript

Contains the name of a JavaScript function that should be invoked as a validation event while users draw new links.

LinkDeletedScript

Contains the name of a JavaScript function that should be invoked when a link is deleted, either programmatically or by the user.

LinkDeletingScript

Contains the name of a JavaScript function that should be invoked as a validation event when the user tries to delete a link.

LinkDeselectedScript

Contains the name of a JavaScript function that should be invoked when the user deselects a link.

LinkDoubleClickedScript

Contains the name of a JavaScript function that should be invoked when the users double-clicks a link.

LinkModifiedScript

Contains the name of a JavaScript function that should be invoked when the user moves a link's control point.

LinkModifyingScript

Contains the name of a JavaScript function that should be invoked as a validation event while a link is being modified.

LinkMouseEnterScript

Contains the name of a JavaScript function that should be invoked when the mouse pointer enters a link.

LinkMouseLeaveScript

Contains the name of a JavaScript function that should be invoked when the mouse pointer leaves a link.

LinkPastedScript

Contains the name of a JavaScript function that should be invoked when a diagram link is pasted from clipboard.

LinkSelectedScript

Contains the name of a JavaScript function that should be invoked when the user selects a link.

LinkTarget

Gets or sets the value of the TARGET attribute of AREA tags generated in ImageMap mode.

LinkTextEditedScript

Contains the name of a JavaScript function that should be invoked when the user edits the text of a link.

MagnifierEnabled

Gets or sets a value indicating whether the magnifier tool is currently enabled.

MagnifierFactor

Gets or sets the zoom factor of the magnifier tool.

MagnifierFrameColor

Gets or sets the color of the magnifier frame.

MagnifierFrameThickness

Gets or sets the thickness of the magnifier frame, expressed in pixels.

MagnifierHeight

Gets or sets the height of the magnifier tool, expressed in pixels.

MagnifierSecondaryFrameColor

Gets or sets the secondary color of the magnifier frame.

MagnifierShading

Gets or sets a value indicating whether to enhance the effect of a magnifier lense by using a gradient shading.

MagnifierShape

Gets or sets the shape of the magnifier tool.

MagnifierWidth

Gets or sets the width of the magnifier tool, expressed in pixels.

MaxImageSize

Specifies the size of the image tiles when ClientSideMode is ImageMap. Image maps can be split into multuple images to avoid problems with large images.

MaxJsonLength

Gets or sets the maximum length of JSON strings that are accepted by internal JavaScriptSerializer instances.

MinVisibleFontSize

Gets or sets a threshold value that hides text if scaled font sizes become smaller.

ModificationStart

Gets or sets how users can start modifying diagram items.

MsAjaxLocation

Gets or sets the URL to the Microsoft Ajax script file.

NodeClickedScript

Contains the name of a JavaScript function that should be invoked when the users clicks a node.

NodeCreatedScript

Contains the name of a JavaScript function that should be invoked when the user draws a new node.

NodeCreatingScript

Contains the name of a JavaScript function that should be invoked as a validation event while users draw new nodes.

NodeDeletedScript

Contains the name of a JavaScript function that should be invoked when a node is deleted, either programmatically or by the user.

NodeDeletingScript

Contains the name of a JavaScript function that should be invoked as a validation event when the user tries to delete a node.

NodeDeselectedScript

Contains the name of a JavaScript function that should be invoked when the user deselects a node.

NodeDomCreatedScript

Sets the name of a JavaScript function that should be invoked when the content of a ControlNode is added to the page DOM.

NodeDoubleClickedScript

Contains the name of a JavaScript function that should be invoked when the users double-clicks a node.

NodeModifiedScript

Contains the name of a JavaScript function that should be invoked when the user moves or resizes a node.

NodeModifyingScript

Contains the name of a JavaScript function that should be invoked as a validation event while a node is being modified.

NodeMouseEnterScript

Contains the name of a JavaScript function that should be invoked when the mouse pointer enters a node.

NodeMouseLeaveScript

Contains the name of a JavaScript function that should be invoked when the mouse pointer leaves a node.

NodePastedScript

Contains the name of a JavaScript function that should be invoked when a diagram node is pasted from clipboard.

NodeSelectedScript

Contains the name of a JavaScript function that should be invoked when the user selects a node.

NodeTextEditedScript

Contains the name of a JavaScript function that should be invoked when the user edits the text of a node.

RecursionLimit

Gets or sets the limit for constraining the number of object levels to process by internal JavaScriptSerializer instances.

ScrollX

Gets or sets the document's X scroll position.

ScrollY

Gets or sets the document's Y scroll position.

SelectionModifyingScript

Contains the name of a JavaScript function that should be invoked while the user is moving or resizing multiple items.

SelectionMovingScript

Contains the name of a JavaScript function that should be invoked while the user is moving multiple selected items, this event lets you cancel the modification.

SerializeTagScript

Contains the name of a JavaScript function that should be invoked when custom data associated with a diagram item must be transferred from the browser to the server.

ShapeLibraryLocation

The location of a shape library file containing custom shape definitions.

ShowScrollbars

Specifies whether scrollbars should be displayed in ImageMap mode.

TableColumnResizedScript

Contains the name of a JavaScript function that should be invoked when the user finishes resizing a column in a table interactively.

TableColumnResizingScript

Contains the name of a JavaScript function that should be invoked when the user resizes a column in a table interactively.

TableRowResizedScript

Contains the name of a JavaScript function that should be invoked when the user finishes resizing a row in a table interactively.

TableRowResizingScript

Contains the name of a JavaScript function that should be invoked when the user resizes a row in a table interactively.

TimeStampImage

Gets or sets a value indicating whether a timestamp should be added to the generated image URL. Use this to prevent browsers from caching the diagram image.

TooltipDelay

Gets or sets the delay before a tooltip is shown.

TreeCollapsedScript

Contains the name of a JavaScript function that should be invoked when the user collapses a tree branch by clicking the [-] button of an Expandable node.

TreeExpandedScript

Contains the name of a JavaScript function that should be invoked when the user expands a tree branch by clicking the [+] button of an Expandable node.

ZoomFactor

Gets or sets the zoom factor used to scale up or down the diagram.

 Public Methods

  Name Description

ClientToDoc

Overloaded.  

ClientToDocUnscaled

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

Dispose

Overloaded.  

DocToClient

Overloaded.  

DocToClientUnscaled

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

GetScrollX

Implements IZoomTarget.GetScrollX.

GetScrollY

Implements IZoomTarget.GetScrollY.

GetZoomLevel

Implements IZoomTarget.GetZoomLevel.

GetZoomStep

Implements IZoomTarget.GetZoomStep.

HtmlEscape

Escapes special html attribute characters with html references to generate a string that can be safely inserted in an html attribute.

JavascriptEscape

Escapes special javascript characters with backslashes to generate javascript string constant whose value is equal to the argument.

LoadFromFile

Loads a diagram from a file.

LoadFromJson

Loads the diagram from JSON string.

LoadFromStream

Loads the Diagram document from a stream.

LoadFromString

Loads the diagram data from a string.

LoadFromXml

Overloaded.  

LoadPostData

IPostBackDataHandler.LoadPostData implementation.

RaiseDeleting

Raises the appropriate Deleting event.

RaisePostDataChangedEvent

IPostBackDataHandler.RaisePostDataChangedEvent implementation.

RegisterConverters

Registers converters used for JSON serialization of custom item types.

RegisterItemType

Overloaded.  

RenderBeginTag

WebControl.RenderBeginTag override.

SaveToFile

Saves the diagram into a file.

SaveToStream

Saves the diagram data into a stream.

SaveToString

Saves the diagram as an ASCII string.

SaveToXml

Overloaded.  

SetScrollX

Implements IZoomTarget.SetScrollX.

SetScrollY

Implements IZoomTarget.SetScrollY.

SetZoomLevel

Implements IZoomTarget.SetZoomLevel.

SetZoomStep

Implements IZoomTarget.SetZoomStep.

 Protected Methods

  Name Description

LoadControlState

WebControl.LoadControlState override.

OnCellClicked

Raises the CellClicked event.

OnCellTextEdited

Raises the CellTextEdited event.

OnInit

WebControl.OnInit override.

OnLinkClicked

Raises the LinkClicked event.

OnLinkCreated

Raises the LinkCreated event.

OnLinkDeleted

Raises the LinkDeleted event.

OnLinkDeleting

Raises the LinkDeleting event.

OnLinkModified

Raises the LinkModified event.

OnLinkTextEdited

Raises the LinkTextEdited event.

OnNodeClicked

Raises the NodeClicked event.

OnNodeCreated

Raises the NodeCreated event.

OnNodeDeleted

Raises the NodeDeleted event.

OnNodeDeleting

Raises the NodeDeleting event.

OnNodeModified

Raises the NodeModified event.

OnNodeTextEdited

Raises the NodeTextEdited event.

OnPreRender

Control.OnPreRender override.

OnTreeCollapsed

Raises the TreeCollapsed event.

OnTreeExpanded

Raises the TreeExpanded event.

RenderContents

WebControl.RenderContents override.

SaveControlState

WebControl.SaveControlState override.

 Public Events

  Name Description

CellClicked

Raised when the user clicks a table's cell.

CellTextEdited

Raised when the user edits the text of a tableís cell.

CreatingAreaElement

Allows adding custom attributes to the AREA elements generated in ImageMap mode.

LinkClicked

Raised when the user clicks a link.

LinkCreated

Raised when the user creates a node.

LinkDeleted

Raised when the user deletes a link.

LinkDeleting

Raised when the user tries to delete a link, this event lets you cancel the operation.

LinkModified

Raised when the user modifies a link.

LinkTextEdited

Raised when the user edits the text of a link.

NodeClicked

Raised when the user clicks a node.

NodeCreated

Raised when the user creates a node.

NodeDeleted

Raised when the user deletes a node.

NodeDeleting

Raised when the user tries to delete a node, this event lets you cancel the operation.

NodeModified

Raised when the user modifies a node.

NodeTextEdited

Raised when the user edits the text of a node.

TreeCollapsed

Raised when a user collapses a tree branch by clicking the [-] button of an Expandable node.

TreeExpanded

Raised when a user expands a tree branch by clicking the [+] button of an Expandable node.

 See Also

DiagramView Class
MindFusion.Diagramming.WebForms Namespace