Search
DiagramPage Members
Constructors Properties Methods
 


Represents a single page in a DiagramDocument object.

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

 Public Constructors

  Name Description

DiagramPage

Initializes a new instance of the DiagramPage class.

 Public Properties

  Name Description

activeItem

Gets the active diagram item. (Inherited from Diagram.)

activeItemHandlesStyle

Gets or sets the visual style of adjustment handles of the active item. (Inherited from Diagram.)

adjustmentHandlesSize

Gets or sets the size of adjustment handles that appear around selected items. (Inherited from Diagram.)

alignToGrid

Gets or sets a value indicating whether the diagram items should be aligned to a grid. (Inherited from Diagram.)

allowMultipleResize

Gets or sets a value indicating whether multiple selected nodes can be resized simultaneously. (Inherited from Diagram.)

allowSelfLoops

Gets or sets a value indicating whether users are allowed to draw reflexive links. (Inherited from Diagram.)

allowSplitLinks

Gets or sets a value indicating whether link segments can be added and removed interactively. (Inherited from Diagram.)

allowUnanchoredLinks

Gets or sets a value indicating whether users can link nodes that do not have designated anchor points. (Inherited from Diagram.)

allowUnconnectedLinks

Gets or sets a value indicating whether users are allowed to draw links that are not connected to any node. (Inherited from Diagram.)

autoArrangeAvoidContainers

Gets or sets a value indicating whether auto-arranged link labels should avoid containers. (Inherited from Diagram.)

autoArrangeAvoidSegments

Gets or sets a value indicating whether auto-arranged link labels should avoid link segments. (Inherited from Diagram.)

autoCloseDistance

Gets or sets the maximum distance between first and last points of a FreeFormNode for which the node's outline is closed automatically. (Inherited from Diagram.)

autoDeleteLinks

Gets or sets whether links are deleted automatically when their origin or destination is deleted. (Inherited from Diagram.)

autoResize

Gets or sets a value indicating whether the document area should be resized automatically so it fits the diagram contents. (Inherited from Diagram.)

backBrush

Gets or sets an object specifying how to fill the diagram background. (Inherited from Diagram.)

backgroundImageAlign

Gets or sets a value indicating how to align the background image. (Inherited from Diagram.)

backgroundImageContent

Gets or sets a Base64-encoded image to display as diagram background. (Inherited from Diagram.)

backgroundImageUrl

Gets or sets URL of the image to paint as diagram's background. (Inherited from Diagram.)

crossingRadius

Gets or sets the radius length of decorations displayed at link intersection points. (Inherited from Diagram.)

customLinkType

Gets or sets the type of DiagramLink objects to create when users starts drawing. (Inherited from Diagram.)

customNodeType

Gets or sets the type of DiagramNode objects to create when users starts drawing. (Inherited from Diagram.)

defaultShape

Gets or sets the default shape assigned to new ShapeNode objects. (Inherited from Diagram.)

dirty

Gets or sets a value indicating whether the diagram has changed since loading it. (Inherited from Diagram.)

disabledHandlesStyle

Gets or sets the visual style of disabled adjustment handles. (Inherited from Diagram.)

dynamicLinks

Gets or sets initial value of the dynamic property of new links. (Inherited from Diagram.)

expandButtonAction

Gets or sets how the control responds to users clickingthe +/- button displayed by expandable nodes. (Inherited from Diagram.)

expandOnIncoming

Gets or sets a value indicating the link direction in which tree branches are expanded. (Inherited from Diagram.)

factory

Gets a Factory object that lets you programmatically add new items to the diagram. (Inherited from Diagram.)

font

Gets or sets the default font of text displayed by diagram items. (Inherited from Diagram.)

freeFormAttractDistance

Gets or sets the radius around dragged free-form adjustment handle in which other points of FreeFormNode are modified too. (Inherited from Diagram.)

freeFormTargets

Gets or sets an array of Shape objects used to replace FreeFormNode instances with ShapeNode ones when behavior is set to LinkFreeShapes or DrawFreeShapes. (Inherited from Diagram.)

gridColor

Gets or sets the color of grid points. (Inherited from Diagram.)

gridOffsetX

Gets or sets the horizontal offset of the first point of the alignment grid. (Inherited from Diagram.)

gridOffsetY

Gets or sets the vertical offset of the first point of the alignment grid. (Inherited from Diagram.)

gridPointSize

Gets or sets the size of shapes used to represent grid points. (Inherited from Diagram.)

gridSizeX

Gets or sets the horizontal distance between adjacent grid points. (Inherited from Diagram.)

gridSizeY

Gets or sets the vertical distance between adjacent grid points. (Inherited from Diagram.)

gridStyle

Gets or sets the visual style of the alignment grid. (Inherited from Diagram.)

iconUrl

Gets or sets URL of the image to paint as the page's icon.

items

Returns an array of all items in this diagram. (Inherited from Diagram.)

laneGrid

Gets the lane grid. (Inherited from Diagram.)

linkBaseShape

Gets or sets the shape displayed at the base of new links. (Inherited from Diagram.)

linkBaseShapeSize

Gets or sets the default size of arrowheads at base of new links. (Inherited from Diagram.)

linkBrush

Gets or sets the default fill of link arrowheads. (Inherited from Diagram.)

linkCrossings

Gets or sets a value indicating how to render the intersection points of links. (Inherited from Diagram.)

linkHeadShape

Gets or sets the shape displayed as head of new links. (Inherited from Diagram.)

linkHeadShapeSize

Gets or sets the default size of arrowheads. (Inherited from Diagram.)

linkHitDistance

Gets or sets a value specifying how far from a link a click is still considered a hit. (Inherited from Diagram.)

linkPen

Gets or sets the default stroke of links. (Inherited from Diagram.)

linkRouter

Gets or sets the object used to find paths for auto-routed links when diagram nodes are added or their positions change. (Inherited from Diagram.)

links

Returns an array of all links in this diagram. (Inherited from Diagram.)

linkSegments

Gets or sets the default number of link segments. (Inherited from Diagram.)

linkShape

Gets or sets the initial shape assigned to new links. (Inherited from Diagram.)

linkTextStyle

Gets or sets the default text placement and orientation of new links. (Inherited from Diagram.)

mergeThreshold

Gets or sets the maximum distance between adjacent control points of a link at which the respective segments can be merged. (Inherited from Diagram.)

nodeEffects

Gets the global effects applied to nodes in this diagram. (Inherited from Diagram.)

nodes

Returns an array of all nodes in this diagram. (Inherited from Diagram.)

nodesExpandable

Gets or sets a value indicating whether newly created nodes are expandable. (Inherited from Diagram.)

roundedLinks

Gets or sets a value indicating whether the joints between segments of Polyline and Cascading links should be rounded. (Inherited from Diagram.)

roundedLinksRadius

Gets or sets the radius of joint arcs of rounded links' segments. (Inherited from Diagram.)

routeLinks

Gets or sets initial value of the autoRoute property of new links. (Inherited from Diagram.)

routeMargin

Gets or sets the minimal distance between nodes and auto-routed links. (Inherited from Diagram.)

selectedItemHandlesStyle

Gets or sets the visual style of adjustment handles of selected items. (Inherited from Diagram.)

selection

Gets a Selection instance that represents the selection of items in this diagram. (Inherited from Diagram.)

shadowOffsetX

Gets or sets the horizontal offset of items' shadows. (Inherited from Diagram.)

shadowOffsetY

Gets or sets the vertical offset of items' shadows. (Inherited from Diagram.)

shadowsStyle

Gets or sets the style of shadows. (Inherited from Diagram.)

shapeBrush

Gets or sets the default fill of ShapeNode objects. (Inherited from Diagram.)

shapeLibraryLocation

Gets or sets the location of a shape library file containing custom shape definitions. It can be set to a full URL of the file, or a relative file path. (Inherited from Diagram.)

shapePen

Gets or sets the default stroke of ShapeNode objects. (Inherited from Diagram.)

showAnchors

Gets or sets a value indicating when to display anchor point marks. (Inherited from Diagram.)

showDisabledHandles

Gets or sets a value indicating whether adjustment handles are painted when they are disabled. (Inherited from Diagram.)

showGrid

Gets or sets a value indicating whether the alignment grid is visible. (Inherited from Diagram.)

showLaneGrid

Gets or sets a value indicating whether the lane grid is visible. (Inherited from Diagram.)

style

Gets or sets the style associated with this diagram. (Inherited from Diagram.)

tag

Gets or sets custom data associated with this diagram. (Inherited from Diagram.)

theme

Gets or sets the theme associated with this diagram. (Inherited from Diagram.)

title

Gets or sets the page title.

titleColor

Gets or sets the color of the title when the title is displayed.

undoEnabled

Gets or sets a value indicating whether saving action records for later undo is enabled. (Inherited from Diagram.)

validityChecks

Gets or sets a value indicating whether validity checks are performed each time an item is added to the diagram. (Inherited from Diagram.)

version

Gets a string identifying current version of the library. (Inherited from Diagram.)

 Public Methods

  Name Description

addItem

Adds an item to the Diagram. (Inherited from Diagram.)

alignPointToGrid

Returns a point of the alignment grid nearest to the one passed as an argument. (Inherited from Diagram.)

arrange

Arranges the diagram with the given layout. (Inherited from Diagram.)

arrangeAnimated

Arranges the diagram using the given layout, and animates items moving to their new positions. (Inherited from Diagram.)

arrangeLinkLabels

Rearranges link labels whose autoArrange property is enabled. (Inherited from Diagram.)

cancelCompositeOperation

Stops recording undo/redo commands into a CompositeCommand and discards the records created so far. (Inherited from Diagram.)

clearAll

Removes all items from the diagram. (Inherited from Diagram.)

commitCompositeOperation

Stops recording undo/redo commands into a CompositeCommand and saves the composite in the history queue. (Inherited from Diagram.)

executeCommand

Executes the specified command on this diagram. (Inherited from Diagram.)

fromJson

Deserializes the diagram from a JSON string. (Inherited from Diagram.)

fromXmlDocument

Loads diagram contents from specified XML Document. (Inherited from Diagram.)

getContentBounds

Returns the smallest rectangle that bounds all diagram items. (Inherited from Diagram.)

getItemAt

Finds and returns the topmost DiagramItem found at the specified location. (Inherited from Diagram.)

getItemsAt

Finds and returns an array of the diagram items found at the specified location. (Inherited from Diagram.)

getLinkAt

Finds and returns the topmost DiagramLink found at the specified location. (Inherited from Diagram.)

getLinksAt

Finds and returns an array of the diagram DiagramLinks found at the specified location. (Inherited from Diagram.)

getNearestNode

Returns the node nearest to the specified point. (Inherited from Diagram.)

getNodeAt

Finds and returns the topmost DiagramNode found at the specified location. (Inherited from Diagram.)

getNodesAt

Finds and returns an array of the DiagramNodes found at the specified location. (Inherited from Diagram.)

isItemInteractive

Checks if the specified item can be modified interactively. (Inherited from Diagram.)

isItemVisible

Checks if the specified item is currently visible. (Inherited from Diagram.)

loadFromString

Loads diagram contents from specified XML or JSON string. (Inherited from Diagram.)

loadFromXml

Loads the diagram from an XML file. (Inherited from Diagram.)

raiseClicked

Raises an event which notifies that a Diagram item has been clicked. (Inherited from Diagram.)

raiseCreated

Raises an event which notifies that a Diagram item has been created. (Inherited from Diagram.)

raiseDeleted

Raises an event which notifies that a Diagram item has been deleted. (Inherited from Diagram.)

raiseDeselected

Raises an event which notifies that a Diagram item has been deselected. (Inherited from Diagram.)

raiseDoubleClicked

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

raiseModified

Raises an event which notifies that a Diagram item has been modified. (Inherited from Diagram.)

raisePasted

Raises an event which notifies that a Diagram item has been pasted from clipboard. (Inherited from Diagram.)

raiseSelected

Raises an event which notifies that a Diagram item has been selected. (Inherited from Diagram.)

raiseSelecting

Raises an event which notifies that a Diagram item will be selected. (Inherited from Diagram.)

raiseSelectionChanged

Raises an event which notifies that the selection has changed. (Inherited from Diagram.)

redo

Executes again an action saved in the command history. (Inherited from Diagram.)

registerClass

Registers a diagram item class. (Inherited from Diagram.)

registerItemClass

Registers a diagram item class for XML serialization support. (Inherited from Diagram.)

removeItem

Removes the specified item from the Diagram. (Inherited from Diagram.)

resizeToFitItem

Resize the document extents so that the specified item is contained within. (Inherited from Diagram.)

resizeToFitItems

Resizes the document scrollable area so that it fits all diagram items. (Inherited from Diagram.)

routeAllLinks

Routes all links in the diagram in such a way they do not cross nodes. (Inherited from Diagram.)

saveToString

Encodes the diagram contents into an XML or JSON string. (Inherited from Diagram.)

saveToXml

Saves the diagram to an XML file. (Inherited from Diagram.)

startCompositeOperation

Starts recording undo/redo commands into a CompositeCommand. (Inherited from Diagram.)

toJson

Serializes the diagram into a JSON string. (Inherited from Diagram.)

toXmlDocument

Saves the diagram into an XML Document. (Inherited from Diagram.)

undo

Undoes an action saved in the command history. (Inherited from Diagram.)

 See Also