Search
ControlNode Members
Constructors Properties Methods
 


ControlNode instances are diagram nodes that render HTML content.

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

 Public Constructors

  Name Description

ControlNode

Initializes a new instance of the ControlNode class with default values supplied from the specified Diagram.

 Public Properties

  Name Description

allowIncomingLinks

Gets or sets whether users are allowed to draw incoming links to this node. (Inherited from DiagramNode.)

allowOutgoingLinks

Gets or sets whether users are allowed to draw outgoing links from this node. (Inherited from DiagramNode.)

anchorPattern

Gets or sets the anchor points to which links attach when connected to this node. (Inherited from DiagramNode.)

attachedNodes

Returns the nodes attached to this node. (Inherited from DiagramNode.)

bounds

Gets or sets a rectangle that defines the position of this node. (Inherited from DiagramNode.)

brush

Gets or sets an object specifying how to fill the interior of this item. (Inherited from DiagramItem.)

center

Gets the center of this node's bounding rectangle. (Inherited from DiagramNode.)

container

Gets the parent ContainerNode containing this node. (Inherited from DiagramItem.)

cornerRadius

Gets or sets the corner radius of nodes whose shape is set to a rounded rectangle. (Inherited from DiagramNode.)

effectiveBrush

Gets the effective brush that should be used to paint this item. (Inherited from DiagramItem.)

effectiveCaptionBackBrush

Gets the effective brush that should be used to paint node's caption bar. (Inherited from DiagramItem.)

effectiveEffects

Gets the effects applied to this node. (Inherited from DiagramNode.)

effectiveFont

Gets the effective font that should be used to render this item's text. (Inherited from DiagramItem.)

effectiveFontName

Gets the name of the effective font that should be used to render this item's text. (Inherited from DiagramItem.)

effectiveFontSize

Gets the size of the effective font that should be used to render this item's text. (Inherited from DiagramItem.)

effectiveFontStyle

Gets the style of the effective font that should be used to render this item's text. (Inherited from DiagramItem.)

effectiveOpacity

Gets the effective opacity that should be used to paint this item. (Inherited from DiagramItem.)

effectiveShadowColor

Gets the effective color that should be used to render this item's shadow. (Inherited from DiagramItem.)

effectiveStroke

Gets the effective color that should be used to stroke this item. (Inherited from DiagramItem.)

effectiveStrokeDashArray

Gets the effective line dash array that should be applied when stroking this item. (Inherited from DiagramItem.)

effectiveStrokeDashOffset

Gets the effective line dash offset that should be applied when stroking this item. (Inherited from DiagramItem.)

effectiveStrokeDashStyle

Gets the effective line dash pattern that should be applied when stroking this item. (Inherited from DiagramItem.)

effectiveStrokeThickness

Gets the effective line thickness that should be applied when stroking this item. (Inherited from DiagramItem.)

effectiveTextColor

Gets the effective text color that should be used to render this item's text. (Inherited from DiagramItem.)

effectiveTextStroke

Gets the effective text color that should be used to render this item's text outline. (Inherited from DiagramItem.)

effectiveTextStrokeThickness

Gets the effective width of the text outline of this item. (Inherited from DiagramItem.)

effects

Gets the effects applied to this node. (Inherited from DiagramNode.)

enabledHandles

Gets or sets a value indicating which adjustment handles are enabled for this node. (Inherited from DiagramNode.)

expandable

Gets or sets whether users are allowed to expand or collapse the subtree rooted at this node. (Inherited from DiagramNode.)

expanded

Gets or sets whether the subtree rooted at this node is expanded. (Inherited from DiagramNode.)

font

Gets or sets the font used to render item's text. (Inherited from DiagramItem.)

graphicsContent

Gets an array of visual elements used to render this item on the canvas. (Inherited from DiagramItem.)

handlesStyle

Gets or sets a value specifying appearance and behavior of node's adjustment handles. (Inherited from DiagramNode.)

hyperLink

Gets or sets the hyperlink associated with this diagram item. (Inherited from DiagramItem.)

id

Gets or sets a custom identifier associated with this item. (Inherited from DiagramItem.)

ignoreLayout

Gets or sets a value indicating whether the position of this item should not be changed by automatic layout methods. (Inherited from DiagramItem.)

incomingLinks

Gets the incoming links to this node. (Inherited from DiagramNode.)

layoutTraits

Gets an object containing properties specific to individual layout algorithms. (Inherited from DiagramItem.)

lineAlignment

Gets or sets the vertical alignment of item's text. (Inherited from DiagramItem.)

locked

Gets or sets whether users are allowed to interact with this item. (Inherited from DiagramItem.)

masterNode

Returns the node to which this node is attached. (Inherited from DiagramNode.)

obstacle

Gets or sets whether this node is considered an obstacle by link routing algorithms. (Inherited from DiagramNode.)

opacity

Gets or sets opacity of this item. (Inherited from DiagramItem.)

outgoingLinks

Gets the outgoing links from this node. (Inherited from DiagramNode.)

parent

Gets the Diagram to which this item belongs. (Inherited from DiagramItem.)

pen

Gets or sets the color used to stroke item's borders. (Inherited from DiagramItem.)

rotationAngle

Gets or sets the angle at which this node is rotated. (Inherited from DiagramNode.)

selected

Gets or sets a value indicating whether a diagram item is selected. (Inherited from DiagramItem.)

shadowColor

Gets or sets the color used to draw item's shadow. (Inherited from DiagramItem.)

shadowOffsetX

Gets or sets the horizontal offset of item's shadow. (Inherited from DiagramItem.)

shadowOffsetY

Gets or sets the vertical offset of item's shadow. (Inherited from DiagramItem.)

showDeleteButton

Gets or sets whether this node displays a delete button. (Inherited from DiagramNode.)

stroke

Gets or sets the color used to stroke item's frame. (Inherited from DiagramItem.)

strokeDashArray

Gets or sets an array of values specifying the dash pattern. (Inherited from DiagramItem.)

strokeDashOffset

Gets or sets the the distance between the line start and the beginning of the dash pattern. (Inherited from DiagramItem.)

strokeDashStyle

Gets or sets the line dash pattern applied when stroking item's frame. (Inherited from DiagramItem.)

strokeThickness

Gets or sets the line width applied when stroking item's frame. (Inherited from DiagramItem.)

style

Gets or sets the style associated with this item. (Inherited from DiagramItem.)

tag

Gets or sets custom data tag associated with this item. (Inherited from DiagramItem.)

template

Gets or sets HTML string representing the DOM content rendered by this node.

text

Gets or sets the text label displayed by this item. (Inherited from DiagramItem.)

textAlignment

Gets or sets the horizontal alignment of item's text. (Inherited from DiagramItem.)

textColor

Gets or sets the color used to fill item's text. (Inherited from DiagramItem.)

textComponent

Gets the Text object instance used to render item's text. (Inherited from DiagramItem.)

textPadding

Gets or sets the padding distance between item's boundaries and text label. (Inherited from DiagramItem.)

textStroke

Gets or sets the color used to stroke item's text. (Inherited from DiagramItem.)

textStrokeThickness

Gets or sets the outline width of item's text. (Inherited from DiagramItem.)

tooltip

Gets or sets tooltip text that should be displayed when the mouse hovers over this item. (Inherited from DiagramItem.)

topLevel

Gets if this is a top-level item in the diagram. (Inherited from DiagramItem.)

visible

DiagramItem.visible override. Gets or sets whether this node is visible.

weight

Gets or sets a weight value used by layout and path-finding algorithms. (Inherited from DiagramItem.)

zIndex

Gets the z-order position of this item. (Inherited from DiagramItem.)

 Public Methods

  Name Description

acceptLinks

Determines whether the node can be connected with links of the specified type. (Inherited from DiagramNode.)

addCanvasElements

Derived classes must implement this method by adding their graphics primitives to the canvas.elements collection. (Inherited from DiagramItem.)

addLabel

Adds a new label to this item. (Inherited from DiagramItem.)

allowDrag

DiagramItem.allowDrag override. (Inherited from DiagramNode.)

animate

Animates the item. (Inherited from DiagramItem.)

attach

Attaches the specified subordinate node to this node, so that when this node is moved, the subordinate follows it. (Inherited from DiagramNode.)

attachTo

Attaches this node to the specified master node so that when the master is moved, the attached node follows it. (Inherited from DiagramNode.)

clone

DiagramNode.clone override.

containsPoint

DiagramItem.containsPoint override. (Inherited from DiagramNode.)

createConnectionPoint

Creates a connection point between this node and the specified link at the specified point. (Inherited from DiagramNode.)

createImage

Creates the background svg image.

detach

Detaches this node from its current master node. (Inherited from DiagramNode.)

endDrag

DiagramItem.endDrag override. (Inherited from DiagramNode.)

fromJson

DiagramNode.fromJson override.

fromJson

Deserializes this item from a JSON object. (Inherited from DiagramItem.)

getAllLinks

Returns all links connected to this node. (Inherited from DiagramNode.)

getContent

Gets the content element of this node.

getIntersection

Calculates the intersection point between the segment defined by the specified point pair and the node's outline. (Inherited from DiagramNode.)

getOutline

Gets the bounding rectangle of this node. (Inherited from DiagramNode.)

getRepaintBounds

Gets the repaint region for this item, taking into account factors such as pen width, selection handles and shadow. (Inherited from DiagramItem.)

getRotatedBounds

Gets the bounding rectangle of this item when it is rotated. (Inherited from DiagramNode.)

hitTest

Returns the diagram item that contains the specified point. (Inherited from DiagramItem.)

init

Returns a Builder object used to configure this ControlNode instance.

invalidate

Invalidates the region of the canvas, that matches the item's repaint bounds. (Inherited from DiagramItem.)

loadFromXml

DiagramNode.loadFromXml override. Loads the node's content from an XML element.

onRemove

Called when an item is removed from a Diagram, either by the user, programmatically or via undo / redo. (Inherited from DiagramItem.)

onUpdateBounds

DiagramNode.onUpdateBounds override.

raiseClicked

Raises an event which notifies that a node has been clicked. (Inherited from DiagramNode.)

raiseDoubleClicked

Raises an event which notifies that a node has been double-clicked. (Inherited from DiagramNode.)

removeCanvasElements

DiagramNode.removeCanvasElements override.

removeLabel

Removes the specified label from this item. (Inherited from DiagramItem.)

restoreLocationState

DiagramItem.restoreLocationState override. (Inherited from DiagramNode.)

restoreState

DiagramItem.restoreState override. (Inherited from DiagramNode.)

restoreState

Loads the properties of this diagram item. (Inherited from DiagramItem.)

saveLocationState

DiagramItem.saveLocationState override. (Inherited from DiagramNode.)

saveState

DiagramItem.saveState override. (Inherited from DiagramNode.)

saveToXml

Saves the node's content into an XML element.

setBounds

Sets the rectangle that defines the position of the diagram node. (Inherited from DiagramNode.)

startDrag

Invoked when the user starts dragging this item. (Inherited from DiagramItem.)

toJson

DiagramNode.toJson override.

updateCanvasElements

Derived classes must implement this method to update the item's visual elements. (Inherited from DiagramItem.)

updateDrag

DiagramItem.updateDrag override. (Inherited from DiagramNode.)

With

Returns a Builder object used to configure and create new ControlNode instances.

 See Also