Back to all docs
API Reference / Telerik.Windows.Diagrams.Core / GraphController
New to Telerik UI for WPF? Start a free 30-day trial

GraphController

Class

Main MVC controller. The view type is based on an interface in function of platform independence.

Definition

Namespace:Telerik.Windows.Diagrams.Core

Assembly:Telerik.Windows.Diagrams.Core.dll

Syntax:
C#
public sealed class GraphController : IControllerService, ISerializable

Inheritance: objectGraphController

Implements: IControllerServiceISerializable

Constructors

GraphController(IGraphInternal, IContainerGeneratorInternal)

Initializes a new instance of the GraphController class.

C#
public GraphController(IGraphInternal graph, IContainerGeneratorInternal containerGenerator)
Parameters:graphIGraphInternal

The graph internal.

containerGeneratorIContainerGeneratorInternal

The container generator.

Properties

ServiceLocator

Gets the service locator.

C#
public ServiceLocator ServiceLocator { get; }

Methods

ActivateTool(MouseTool)

Activates the tool.

C#
public void ActivateTool(MouseTool mouseTool)
Parameters:mouseToolMouseTool

The mouse tool.

AddConnection(IConnection, bool)

Adds the connection.

C#
public void AddConnection(IConnection connection, bool isUndoable = true)
Parameters:connectionIConnection

The connection.

isUndoablebool

If set to true [is undoable].

AddShape(IShape, bool)

Adds the shape.

C#
public void AddShape(IShape shape, bool isUndoable = true)
Parameters:shapeIShape

The shape.

isUndoablebool

If set to true [is undoable].

AddShape(object, bool)

Adds the shape.

C#
public IShape AddShape(object item, bool isUndoable = true)
Parameters:itemobject

The item.

isUndoablebool

If set to true [is undoable].

Returns:

IShape

Exceptions:

ArgumentNullException

If the item is null.

AlignShapes(Alignment, IEnumerable<IShape>)

Aligns the shapes to the most left/top/right/bottom edge defined by the selection bounds.

C#
public void AlignShapes(Alignment alignment, IEnumerable<IShape> shapes)
Parameters:alignmentAlignment

Determines whether alignment should be calculated towards left/top/right/bottom edge.

shapesIEnumerable<IShape>

The shapes.

BringForward(IEnumerable<IDiagramItem>, bool)

Brings the selected items forward.

C#
public void BringForward(IEnumerable<IDiagramItem> items, bool isUndoable = true)
Parameters:itemsIEnumerable<IDiagramItem>isUndoablebool

BringToFront(IEnumerable<IDiagramItem>, bool)

Brings the selected items to front.

C#
public void BringToFront(IEnumerable<IDiagramItem> items, bool isUndoable = true)
Parameters:itemsIEnumerable<IDiagramItem>isUndoablebool

ChangeTool(string)

Changes the tool.

C#
public void ChangeTool(string toolName)
Parameters:toolNamestring

Label of the tool.

Clear(bool)

Clears the diagram and resets the document.

C#
public void Clear(bool isItemsCollectionChanging = false)
Parameters:isItemsCollectionChangingbool
Remarks:

The diagram is not saved prior to this reset. You need to handle in the application the eventual necessity to save (or request the user) the diagram before this.

ClearConnections()

Clears the connections.

C#
public void ClearConnections()

ClearShapes()

Clears the shapes.

C#
public void ClearShapes()

Copy()

Creates a copy of the diagram in the clipboard.

C#
public string Copy()
Returns:

string

CreateConnection(IShape, IShape, bool)

Creates the connection.

C#
public IConnection CreateConnection(IShape source, IShape target, bool isUndoable)
Parameters:sourceIShape

The source.

targetIShape

The target.

isUndoablebool

If set to true [is undoable].

Returns:

IConnection

CreateConnectionInGraphSource(IShape, IShape)

Creates the connection in graph source.

C#
public ILink CreateConnectionInGraphSource(IShape source, IShape target)
Parameters:sourceIShape

The source.

targetIShape

The target.

Returns:

ILink

CreateShapeInGraphSource(IShape)

Creates the shape in graph source.

C#
public object CreateShapeInGraphSource(IShape shape)
Parameters:shapeIShape

The shape.

Returns:

object

CutItems()

Cuts the items.

C#
public string CutItems()
Returns:

string

DeleteItems(IEnumerable<IDiagramItem>, bool)

Deletes the items.

C#
public void DeleteItems(IEnumerable<IDiagramItem> itemsToDelete, bool isUndoable)
Parameters:itemsToDeleteIEnumerable<IDiagramItem>

The items to delete.

isUndoablebool

If set to true [is undoable].

DeselectItem(IDiagramItem)

Deselects a specific item.

C#
public void DeselectItem(IDiagramItem deselectedItem)
Parameters:deselectedItemIDiagramItem

Deserialize(SerializationInfo)

Deserializes the specified info.

C#
public void Deserialize(SerializationInfo info)
Parameters:infoSerializationInfo

The info.

Implements: ISerializable.Deserialize(SerializationInfo)

ForceRealization()

Forces the realization.

C#
public void ForceRealization()

Group(string, bool, params IGroupable[])

Groups the selected shapes.

C#
public IGroup Group(string name = null, bool isUndoable = false, params IGroupable[] items)
Parameters:namestring

The name.

isUndoablebool

If set to true the operation [is undoable].

itemsIGroupable[]

The items.

Returns:

IGroup

IsInViewport(IDiagramItem)

Checks if the diagram item is in the viewport.

C#
public bool IsInViewport(IDiagramItem item)
Parameters:itemIDiagramItemReturns:

bool

KeyDown(KeyArgs)

Called when key down event is fired.

C#
public bool KeyDown(KeyArgs e)
Parameters:eKeyArgs

The key args.

Returns:

bool

KeyUp(KeyArgs)

Called when key up event is fired.

C#
public bool KeyUp(KeyArgs e)
Parameters:eKeyArgs

The key args.

Returns:

bool

Layout(LayoutType, object)

Organizes the diagram using the specified layout.

C#
public void Layout(LayoutType type = LayoutType.Sugiyama, object settings = null)
Parameters:typeLayoutType

The layout type to apply.

settingsobject

The settings specific to the layout type.

Load(string)

Loads the serialized diagram.

C#
public void Load(string serializationValue)
Parameters:serializationValuestring

A string supposedly containing some XML representing a serialized diagram.

MergeItems(IEnumerable<IDiagramItem>, string, bool, Point, Size)

Merges the items in the diagram.

C#
public IEnumerable<IDiagramItem> MergeItems(IEnumerable<IDiagramItem> items, string originId, bool usePosition = false, Point position = null, Size size = null)
Parameters:itemsIEnumerable<IDiagramItem>

The items.

originIdstring

The origin id.

usePositionbool

If set to true the given position will be used.

positionPoint

The position.

sizeSize

The size.

Returns:

IEnumerable<IDiagramItem>

MouseDoubleClick(PointerArgs)

Handles the mouse double click event.

C#
public void MouseDoubleClick(PointerArgs e)
Parameters:ePointerArgs

The e.

MouseDown(PointerArgs)

Called when the left mouse button is down.

C#
public void MouseDown(PointerArgs e)
Parameters:ePointerArgs

The e.

MouseMove(PointerArgs)

Called when the mouse moves.

C#
public void MouseMove(PointerArgs e)
Parameters:ePointerArgs

The e.

MouseUp(PointerArgs)

Called when the mouse left button is up.

C#
public void MouseUp(PointerArgs e)
Parameters:ePointerArgs

The e.

Nudge(Point)

Nudges (i.e. a small amount of translation) the selected items with the specified amount.

C#
public void Nudge(Point amount)
Parameters:amountPoint

The amount defined as a point (vector).

Remarks:

This is an undoable action and plugs into the same mechanism as the DraggingTool.

OnGraphSourceChanged(IGraphSource)

Called when graph source changes.

C#
public void OnGraphSourceChanged(IGraphSource source)
Parameters:sourceIGraphSource

The source.

OnItemsChanged(NotifyCollectionChangedEventArgs)

Called when Items collection changes.

C#
public void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters:eNotifyCollectionChangedEventArgs

The NotifyCollectionChangedEventArgs instance containing the event data.

OnViewportChanged()

Called when the bounds have changed.

C#
public void OnViewportChanged()

Paste(string)

Pastes a diagram, serialized in the clipboard.

C#
public IEnumerable<IDiagramItem> Paste(string pasteText)
Parameters:pasteTextstringReturns:

IEnumerable<IDiagramItem>

RemoveConnection(IConnection, bool)

Removes the connection.

C#
public void RemoveConnection(IConnection connection, bool isUndoable = false)
Parameters:connectionIConnection

The connection.

isUndoablebool

If set to true [is undoable].

RemoveShape(IShape, bool)

Removes the shape from the diagram.

C#
public void RemoveShape(IShape shape, bool isUndoable = false)
Parameters:shapeIShape

The shape to be removed.

isUndoablebool

If set to true the action will be recorded in the undo stack.

Save()

Returns the serialized diagram as an XML-string.

C#
public string Save()
Returns:

string

SelectItem(IDiagramItem, bool)

Selects a specific item.

C#
public void SelectItem(IDiagramItem selectedItem, bool addToExistingSelection = false)
Parameters:selectedItemIDiagramItemaddToExistingSelectionbool

SendBackward(IEnumerable<IDiagramItem>, bool)

Sends selected items backward.

C#
public void SendBackward(IEnumerable<IDiagramItem> itemsToSend, bool isUndoable = true)
Parameters:itemsToSendIEnumerable<IDiagramItem>isUndoablebool

SendToBack(IEnumerable<IDiagramItem>, bool)

Sends selected items to back.

C#
public void SendToBack(IEnumerable<IDiagramItem> itemsToSend, bool isUndoable = true)
Parameters:itemsToSendIEnumerable<IDiagramItem>isUndoablebool

Serialize()

Serializes this instance.

C#
public SerializationInfo Serialize()
Returns:

SerializationInfo

Implements: ISerializable.Serialize()

SnapShapes(IEnumerable<IShape>)

Snaps the items based on the snap value. The action is enclosed in a undoable command and supports undo/redo.

C#
public void SnapShapes(IEnumerable<IShape> shapes)
Parameters:shapesIEnumerable<IShape>

Ungroup(bool, params IGroup[])

Ungroups the specified items.

C#
public void Ungroup(bool isUndoable = false, params IGroup[] groups)
Parameters:isUndoableboolgroupsIGroup[]
In this article
DefinitionConstructorsGraphController(IGraphInternal, IContainerGeneratorInternal)PropertiesServiceLocatorMethodsActivateTool(MouseTool)AddConnection(IConnection, bool)AddShape(IShape, bool)AddShape(object, bool)AlignShapes(Alignment, IEnumerable<IShape>)BringForward(IEnumerable<IDiagramItem>, bool)BringToFront(IEnumerable<IDiagramItem>, bool)ChangeTool(string)Clear(bool)ClearConnections()ClearShapes()Copy()CreateConnection(IShape, IShape, bool)CreateConnectionInGraphSource(IShape, IShape)CreateShapeInGraphSource(IShape)CutItems()DeleteItems(IEnumerable<IDiagramItem>, bool)DeselectItem(IDiagramItem)Deserialize(SerializationInfo)ForceRealization()Group(string, bool, params IGroupable[])IsInViewport(IDiagramItem)KeyDown(KeyArgs)KeyUp(KeyArgs)Layout(LayoutType, object)Load(string)MergeItems(IEnumerable<IDiagramItem>, string, bool, Point, Size)MouseDoubleClick(PointerArgs)MouseDown(PointerArgs)MouseMove(PointerArgs)MouseUp(PointerArgs)Nudge(Point)OnGraphSourceChanged(IGraphSource)OnItemsChanged(NotifyCollectionChangedEventArgs)OnViewportChanged()Paste(string)RemoveConnection(IConnection, bool)RemoveShape(IShape, bool)Save()SelectItem(IDiagramItem, bool)SendBackward(IEnumerable<IDiagramItem>, bool)SendToBack(IEnumerable<IDiagramItem>, bool)Serialize()SnapShapes(IEnumerable<IShape>)Ungroup(bool, params IGroup[])
Not finding the help you need?
Contact Support