Search
DiagramView Members
Constructors Properties Methods
 


Represents a control that displays the content of a Diagram object.

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 whether users are allowed to edit the text of diagram items.

autoScroll

Gets or sets a value indicating whether automatic scrolling is enabled.

autoScrollAmount

Gets or sets the amount by which to auto-scroll the view when the mouse leaves the view boundaries while drawing.

behavior

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

defaultControlTemplate

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

delKeyAction

Gets or sets what action to perform when users hit the Del key.

diagram

Gets or sets the diagram displayed by this view.

dragIndicatorOpacity

Gets or sets the opacity of ghost image displayed during drag-and-drop from NodeListView.

enableMultiTouch

Gets or sets a value indicating whether the control handles DOM Pointer events to implement multi-touch interactions, such as zooming, node rotation or simultaneous drawing of multiple diagram items.

handleTouchHitDistance

Gets or sets maximum distance between touch position and adjustment handle at which the handle can still be grabbed to modify its item.

horizontalDropAlignment

Gets or sets the horizontal placement of nodes created by drag-and-drop operations, relatively to mouse cursor.

inplaceEditAcceptOnEnter

Gets or sets a value indicating whether pressing the ENTER keyshould exit inplace-edit mode and accept changes made to text.

inplaceEditCancelOnEsc

Gets or sets a value indicating whether pressing the ESC keyshould exit inplace-edit mode and reject changes made to text.

leftButtonActions

Gets or sets a combination of flags that specify what actions can be performed via the left mouse button.

licenseLocation

Gets or sets URL of the control's license file.

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 tool's frame.

magnifierFrameThickness

Gets or sets the thickness of the magnifier frame.

magnifierHeight

Gets or sets the height of the magnifier tool.

magnifierSecondaryFrameColor

Gets or sets the color of the magnifier tool's secondary frame.

magnifierShading

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

magnifierShape

Gets or sets a reference to the geometric shape definition of the magnifier tool.

magnifierWidth

Gets or sets the width of the magnifier tool.

middleButtonActions

Gets or sets a combination of flags that specify what actions can be performed via the middle mouse button.

modificationStart

Gets or sets how users can start modifying diagram items.

modifierKeyActions

Gets an object that allows changing the function of keyboard modifier keys such as Ctrl and Alt.

mouseWheelAction

Gets or sets what action to perform when users rotate the mouse wheel.

multiTouchDraw

Gets or sets a value indicating whether the control allows drawing multiple items simultaneously.

multiTouchModify

Gets or sets a value indicating whether multi-touch modifications are enabled.

multiTouchZoom

Gets or sets a value indicating whether multi-touch zoom is enabled.

rightButtonActions

Gets or sets a combination of flags that specify what actions can be performed via the right mouse button.

scrollX

Gets or sets the diagram's horizontal scroll position.

scrollY

Gets or sets the diagram's vertical scroll position.

scrollZoneSize

Gets or sets the size of the auto scroll zone near the edges of the control.

tooltipDelay

Gets or sets the delay before a tooltip is shown.

verticalDropAlignment

Gets or sets the vertical placement of nodes created by drag-and-drop operations, relatively to mouse cursor.

viewport

Returns the visible portion of the diagram area.

virtualScroll

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

zoomFactor

Gets or sets the zoom factor.

 Public Methods

  Name Description

animate

Animates the view state.

beginEdit

Begins in-place editing of the specified object.

cancelDrag

Cancels all current drag operations.

clearTooltip

Forces the removal of any created tooltips from the diagram canvas.

copyToClipboard

Copies the current selection of items to the clipboard.

create

Creates and initializes a new DiagramView from the specified element. This method is static and can be called without creating an instance of the class.

cutToClipboard

Cuts the currently selected items to the clipboard.

dispose

Control.dispose override.

endEdit

Exits the in-place editing mode and either accepts or rejects the changes made to the item's text.

find

Returns the specified DiagramView object. This member is static and can be invoked without creating an instance of the class.

fromJson

Loads the diagram from a JSON string.

initialize

Control.initialize override.

loadFromXml

Loads the diagram from an XML file.

pasteFromClipboard

Pastes diagram items from the clipboard.

print

Exports the diagram as a list of images to a new HTML document and opens the browser's print dialog.

printPreview

Exports the diagram as a list of images to a new HTML document.

record

Starts recording mouse and keyboard events for subsequent replay.

replay

Replays a sequence of recorded mouse and keyboard events created by record and stopRecording methods.

saveToXml

Saves the diagram to an XML file.

scrollTo

Scrolls the diagram to the specified point.

setScroll

IZoomTarget implementation

setZoomFactorPivot

Sets the zoom factor, preserving the on-screen position of the specified diagram point.

stopRecording

Stops recording mouse and keyboard events.

toJson

Saves the diagram to a JSON string.

zoomToFit

Zooms the view to fit the Diagram contents in component's area.

zoomToRect

Zooms and scrolls the view to fit the specified Diagram region in component's area.

 See Also