Search
Selection Members
Constructors Properties Methods
 


Represents a set of items selected in the Diagram document.

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

 Public Constructors

  Name Description

Selection

Initializes a new instance of the Selection class.

 Public Properties

  Name Description

allowMultipleSelection

Gets or sets a value indicating whether more than one items can be selected simultaneously.

brush

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

container

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

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

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

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

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

items

Returns an array of all items in this selection.

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

links

Returns an array of all links in this selection.

locked

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

nodes

Returns an array of all nodes in this selection.

opacity

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

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

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

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

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

Gets or sets a value indicating whether this item is visible. (Inherited from DiagramItem.)

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

addCanvasElements

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

addItem

Adds an item to the Selection.

addLabel

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

allowDrag

DiagramItem.allowDrag override.

animate

Animates the item. (Inherited from DiagramItem.)

clear

Removes all items from the selection.

clone

Creates a copy of this item. (Inherited from DiagramItem.)

containsPoint

Determines whether this item contains the specified point. (Inherited from DiagramItem.)

endDrag

DiagramItem.endDrag override.

fromJson

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

getBounds

Gets a rectangle that defines the position of the selection frame.

getRepaintBounds

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

hitTest

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

invalidate

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

loadFromXml

Loads the item content from an XML element. (Inherited from DiagramItem.)

onRemove

DiagramItem.onRemove override.

removeCanvasElements

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

removeItem

Removes an item from the Diagram.

removeLabel

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

restoreState

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

saveLocationState

DiagramItem.saveLocationState override.

saveState

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

saveToXml

Saves the item content into an XML element. (Inherited from DiagramItem.)

startDrag

DiagramItem.startDrag override.

startDrag

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

toJson

Serializes this item into a JSON object. (Inherited from DiagramItem.)

updateCanvasElements

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

updateDrag

DiagramItem.updateDrag override.

 See Also