menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfDiagram - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfDiagram

    Represets the diagram control is used for creating diagrams like flow charts, organizational charts, mind maps, floor plans, and swim lane diagrams either through code or through a visual interface.

    Inheritance
    System.Object
    SfDiagram
    Implements
    IGraph
    System.ComponentModel.INotifyPropertyChanged
    Namespace: Syncfusion.UI.Xaml.Diagram
    Assembly: Syncfusion.SfDiagram.WPF.dll
    Syntax
    public class SfDiagram : Control, IGraph, INotifyPropertyChanged

    Constructors

    SfDiagram()

    Cretaes new instance of SfDiagram class.

    Declaration
    public SfDiagram()

    Fields

    AnnotationChangedCommandProperty

    Using a DependencyProperty as the backing store for AnnotationChangedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty AnnotationChangedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    AnnotationConstraintsProperty

    Using a DependencyProperty as the backing store for AnnotationConstraints. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty AnnotationConstraintsProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    AutoScrolledCommandProperty

    Using a DependencyProperty as the backing store for AutoScrolledCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty AutoScrolledCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    BezierSmoothnessProperty

    Using a DependencyProperty as the backing store for BezierSmoothness. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty BezierSmoothnessProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    BpmnGroupDropIndicatorStyleProperty

    Using a DependencyProperty as the backing store for BpmnGroupDropIndicatorStyle. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty BpmnGroupDropIndicatorStyleProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    BridgeDirectionProperty

    Using a DependencyProperty as the backing store for BridgeDirection. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty BridgeDirectionProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    CommandManagerProperty

    Using a DependencyProperty as the backing store for CommandManager. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty CommandManagerProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ConnectionIndicatorStyleProperty

    Using a DependencyProperty as the backing store for ConnectionIndicatorStyle. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ConnectionIndicatorStyleProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ConnectorDropIndicatorStyleProperty

    Using a DependencyProperty as the backing store for ConnectorDropIndicatorStyle. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ConnectorDropIndicatorStyleProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ConnectorEditingCommandProperty

    Using a DependencyProperty as the backing store for ConnectorEditingCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ConnectorEditingCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ConnectorSelectionIndicatorStyleProperty

    Using a DependencyProperty as the backing store for ConnectorSelectionIndicatorStyle. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ConnectorSelectionIndicatorStyleProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ConnectorSourceChangedCommandProperty

    Using a DependencyProperty as the backing store for ConnectorSourceChangedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ConnectorSourceChangedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ConnectorsProperty

    Using a DependencyProperty as the backing store for Connectors. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ConnectorsProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ConnectorTargetChangedCommandProperty

    Using a DependencyProperty as the backing store for ConnectorTargetChangedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ConnectorTargetChangedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ConstraintsProperty

    Using a DependencyProperty as the backing store for Constraints. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ConstraintsProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    DataSourceSettingsProperty

    Using a DependencyProperty as the backing store for DataSourceSettings. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty DataSourceSettingsProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    DefaultConnectorTypeProperty

    Using a DependencyProperty as the backing store for DefaultConnectorType. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty DefaultConnectorTypeProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    DragEnterCommandProperty

    Using a DependencyProperty as the backing store for DragEnterCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty DragEnterCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    DragLeaveCommandProperty

    Using a DependencyProperty as the backing store for DragLeaveCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty DragLeaveCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    DragOverCommandProperty

    Using a DependencyProperty as the backing store for DragOverCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty DragOverCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    DrawingToolProperty

    Using a DependencyProperty as the backing store for DrawingTool. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty DrawingToolProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    DropCommandProperty

    Using a DependencyProperty as the backing store for DropCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty DropCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    EnableConnectorSplittingProperty

    Identifies the EnableConnectorSplitting dependency property.

    Declaration
    public static DependencyProperty EnableConnectorSplittingProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ExportSettingsProperty

    Using a DependencyProperty as the backing store for ExportSettings. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ExportSettingsProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    FirstSelectionIndicatorStyleProperty

    Using a DependencyProperty as the backing store for FirstSelectionIndicatorStyle. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty FirstSelectionIndicatorStyleProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    GetDrawTypeCommandProperty

    Using a DependencyProperty as the backing store for GetDrawTypeCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty GetDrawTypeCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    GetLayoutInfoCommandProperty

    Using a DependencyProperty as the backing store for GetLayoutInfoCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty GetLayoutInfoCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    GroupsProperty

    Using a DependencyProperty as the backing store for Groups. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty GroupsProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    HasChangesProperty

    Identifies the HasChanges dependency property.

    Declaration
    public static DependencyProperty HasChangesProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    HistoryChangedCommandProperty

    Identifies the dependency property.

    Declaration
    public static DependencyProperty HistoryChangedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    HistoryManagerProperty

    Using a DependencyProperty as the backing store for HistoryManager. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty HistoryManagerProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    HitPaddingProperty

    Using a DependencyProperty as the backing store for HitPadding. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty HitPaddingProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    HorizontalRulerProperty

    Using a DependencyProperty as the backing store for HorizontalRuler. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty HorizontalRulerProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ItemAddedCommandProperty

    Using a DependencyProperty as the backing store for ItemAddedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ItemAddedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ItemAddingCommandProperty

    Identifies the ItemAddingCommand dependency property.

    Declaration
    public static DependencyProperty ItemAddingCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ItemDeletedCommandProperty

    Using a DependencyProperty as the backing store for ItemDeletedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ItemDeletedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ItemDeletingCommandProperty

    Using a DependencyProperty as the backing store for ItemDeletingCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ItemDeletingCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ItemDoubleTappedCommandProperty

    Using a DependencyProperty as the backing store for ItemDoubleTappedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ItemDoubleTappedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ItemSelectedCommandProperty

    Using a DependencyProperty as the backing store for ItemSelectedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ItemSelectedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ItemSelectingCommandProperty

    Using a DependencyProperty as the backing store for ItemSelectingCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ItemSelectingCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ItemTappedCommandProperty

    Using a DependencyProperty as the backing store for ItemTappedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ItemTappedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ItemUnSelectedCommandProperty

    Using a DependencyProperty as the backing store for ItemUnSelectedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ItemUnSelectedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ItemUnSelectingCommandProperty

    Using a DependencyProperty as the backing store for ItemUnSelectingCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ItemUnSelectingCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    KnownTypesProperty

    Using a DependencyProperty as the backing store for KnownTypes. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty KnownTypesProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    LaneDropIndicatorStyleProperty

    Using a DependencyProperty as the backing store for LaneDropIndicatorStyle. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty LaneDropIndicatorStyleProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    LayoutManagerProperty

    Using a DependencyProperty as the backing store for LayoutManager. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty LayoutManagerProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    LayoutUpdatedCommandProperty

    Using a DependencyProperty as the backing store for LayoutUpdatedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty LayoutUpdatedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    LineRoutingSettingsProperty

    Using a DependencyProperty as the backing store for LineRoutingSettings. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty LineRoutingSettingsProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    MenuItemClickedCommandProperty

    Using a DependencyProperty as the backing store for MenuItemClickedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty MenuItemClickedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    MenuItemCommandProperty

    Using a DependencyProperty as the backing store for MenuItemCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty MenuItemCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    MenuOpeningCommandProperty

    Using a DependencyProperty as the backing store for MenuOpeningCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty MenuOpeningCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    MenuProperty

    Using a DependencyProperty as the backing store for Menu. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty MenuProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ModelProperty

    Using a DependencyProperty as the backing store for Model. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ModelProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    MouseDownCommandProperty

    Using a DependencyProperty as the backing store for MouseDownCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty MouseDownCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    MouseUpCommandProperty

    Using a DependencyProperty as the backing store for MouseUpCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty MouseUpCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    MultipleSelectionModeProperty

    Using a DependencyProperty as the backing store for MultipleSelectionMode. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty MultipleSelectionModeProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    NodeChangedCommandProperty

    Using a DependencyProperty as the backing store for NodeChangedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty NodeChangedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    NodeDropIndicatorStyleProperty

    Using a DependencyProperty as the backing store for NodeDropIndicatorStyle. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty NodeDropIndicatorStyleProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    NodeSelectionIndicatorStyleProperty

    Using a DependencyProperty as the backing store for NodeSelectionIndicatorStyle. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty NodeSelectionIndicatorStyleProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    NodesProperty

    Using a DependencyProperty as the backing store for Nodes. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty NodesProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ObjectDrawnCommandProperty

    Using a DependencyProperty as the backing store for ObjectDrawnCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ObjectDrawnCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    OutlineSettingsProperty

    Using a DependencyProperty as the backing store for OutlineSettings. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty OutlineSettingsProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    PageProperty

    Using a DependencyProperty as the backing store for Page property. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty PageProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    PageSettingsProperty

    Using a DependencyProperty as the backing store for PageSettings. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty PageSettingsProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    PortChangedCommandProperty

    Using a DependencyProperty as the backing store for PortChangedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty PortChangedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    PortHoverEffectProperty

    Identifies the PortHoverEffect dependency property.

    Declaration
    public static DependencyProperty PortHoverEffectProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    PortVisibilityProperty

    Using a DependencyProperty as the backing store for PortVisibility. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty PortVisibilityProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    PreviewSettingsProperty

    Using a DependencyProperty as the backing store for PreviewSettings. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty PreviewSettingsProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    PrintingCommandProperty

    Using a DependencyProperty as the backing store for PrintingCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty PrintingCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    PrintingServiceProperty

    Using a DependencyProperty as the backing store for PrintingService. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty PrintingServiceProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ResizerConstraintsProperty

    Using a DependencyProperty as the backing store for ResizerConstraints. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ResizerConstraintsProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ScrollSettingsProperty

    Using a DependencyProperty as the backing store for ScrollSettings. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ScrollSettingsProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ScrollViewerRenderModeProperty

    Using a DependencyProperty as the backing store for ScrollViewerRenderMode. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ScrollViewerRenderModeProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    SelectedItemsProperty

    Using a DependencyProperty as the backing store for SelectedItems. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty SelectedItemsProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    SelectorChangedCommandProperty

    Using a DependencyProperty as the backing store for SelectorChangedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty SelectorChangedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    SelectorHandleDisplayModeProperty

    Identifies the SelectorHandleDisplayMode dependency property.

    Declaration
    public static DependencyProperty SelectorHandleDisplayModeProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    SingleSelectionModeProperty

    Using a DependencyProperty as the backing store for SingleSelectionMode. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty SingleSelectionModeProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    SnapSettingsProperty

    Using a DependencyProperty as the backing store for SnapSettings. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty SnapSettingsProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    SwimlaneChildChangedCommandProperty

    Using a DependencyProperty as the backing store for NodeChangedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty SwimlaneChildChangedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    SwimlanesProperty

    Using a DependencyProperty as the backing store for Swimlanes. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty SwimlanesProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ThemeProperty

    Identifies the DiagramTheme dependency property.

    Declaration
    public static DependencyProperty ThemeProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ToolProperty

    Using a DependencyProperty as the backing store for Tool. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ToolProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    VerticalRulerProperty

    Using a DependencyProperty as the backing store for VerticalRuler. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty VerticalRulerProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    ViewPortChangedCommandProperty

    Using a DependencyProperty as the backing store for ViewPortChangedCommand. This enables animation, styling, binding, etc...

    Declaration
    public static DependencyProperty ViewPortChangedCommandProperty
    Field Value
    Type
    System.Windows.DependencyProperty

    Properties

    AnnotationChangedCommand

    Gets or sets the annotationchangedcommand to invoke when the annotation changed

    Declaration
    public ICommand AnnotationChangedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    AnnotationConstraints

    Gets or sets the default behaviors of the annotation.

    Declaration
    public AnnotationConstraints AnnotationConstraints { get; set; }
    Property Value
    Type
    AnnotationConstraints

    AutoScrolledCommand

    Gets or sets the autoscrolledcommand to invoke when perform autoscroll for diagram elements.

    Declaration
    public ICommand AutoScrolledCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    BezierSmoothness

    Gets or sets the beziersmoothness of the diagram.

    Declaration
    public BezierSmoothness BezierSmoothness { get; set; }
    Property Value
    Type
    BezierSmoothness

    BpmnGroupDropIndicatorStyle

    Gets or sets the drop indicator style for the BpmnGroup.

    Declaration
    public Style BpmnGroupDropIndicatorStyle { get; set; }
    Property Value
    Type
    System.Windows.Style

    BridgeDirection

    Gets or sets the direction of line bridges.

    Declaration
    public BridgeDirection BridgeDirection { get; set; }
    Property Value
    Type
    BridgeDirection

    CommandManager

    Gets or sets the CommandManager of the Diagram to customize the keyboad command.

    Declaration
    public CommandManager CommandManager { get; set; }
    Property Value
    Type
    CommandManager

    ConnectionIndicatorStyle

    Gets or sets the connection indicator style for the Node and Port while in connecting state.

    Declaration
    public Style ConnectionIndicatorStyle { get; set; }
    Property Value
    Type
    System.Windows.Style

    ConnectorDropIndicatorStyle

    Gets or sets the drop indicator style for connector.

    Declaration
    public Style ConnectorDropIndicatorStyle { get; set; }
    Property Value
    Type
    System.Windows.Style

    ConnectorEditingCommand

    Gets or sets the connector editing command invokes when the connector is editing.

    Declaration
    public ICommand ConnectorEditingCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    Connectors

    Gets or sets the IConnector collection of the diagram.

    Declaration
    public object Connectors { get; set; }
    Property Value
    Type
    System.Object

    ConnectorSelectionIndicatorStyle

    Gets or sets the selection indicator style for the Connector.

    Declaration
    public Style ConnectorSelectionIndicatorStyle { get; set; }
    Property Value
    Type
    System.Windows.Style

    ConnectorSourceChangedCommand

    Gets or sets the connectorsourcechangedcommand to invoke when the connector source thumb is changed.

    Declaration
    public ICommand ConnectorSourceChangedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    ConnectorTargetChangedCommand

    Gets or sets the connectortargetchangedcommand to invoke when the connector target thumb is changed.

    Declaration
    public ICommand ConnectorTargetChangedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    Constraints

    Gets or sets the default behaviors of the diagram.

    Declaration
    public GraphConstraints Constraints { get; set; }
    Property Value
    Type
    GraphConstraints

    DataSourceSettings

    Gets or sets the data source that is to be bound with diagram.

    Declaration
    public IDataSourceSettings DataSourceSettings { get; set; }
    Property Value
    Type
    IDataSourceSettings

    DefaultConnectorType

    Gets or sets the default connectortype.

    Declaration
    public ConnectorType DefaultConnectorType { get; set; }
    Property Value
    Type
    ConnectorType

    DragEnterCommand

    Gets or sets the itemdragcommand to invoke when the input system reports an underlying drag command with this element as the drag target.

    Declaration
    public ICommand DragEnterCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    DragLeaveCommand

    Gets or sets the itemdragleavecommand to invoke when the input system reports an underlying drag command with this element as the drag origin.

    Declaration
    public ICommand DragLeaveCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    DragOverCommand

    Gets or sets the itemdragovercommand to invoke when the input system reports an underlying drag command with this element as the potential drop target.

    Declaration
    public ICommand DragOverCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    DragOverNode

    Gets or sets the node on which the mouse point is dragging.

    Declaration
    public Node DragOverNode { get; set; }
    Property Value
    Type
    Node

    DragOverPort

    Gets or sets the port on which the mouse point is dragging.

    Declaration
    public NodePort DragOverPort { get; set; }
    Property Value
    Type
    NodePort

    DrawingTool

    Gets or sets the type of object to be drawn through drawing tool.

    Declaration
    public DrawingTool DrawingTool { get; set; }
    Property Value
    Type
    DrawingTool

    DropCommand

    Gets or sets the itemdropcommand to invoke when the input system reports an underlying drop command with this element as the drop target.

    Declaration
    public ICommand DropCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    EnableConnectorSplitting

    Gets or sets the value indicating whether a connector can be splitted or not when node dropped on a connector.

    Declaration
    public bool EnableConnectorSplitting { get; set; }
    Property Value
    Type Description
    System.Boolean

    true the connector will be splitted when the node is dropped on the connector; otherwise, false. The default value is false.

    ExportSettings

    Gets or sets the content of the diagram can be exported as raster image files by using Export function.

    Declaration
    public ExportSettings ExportSettings { get; set; }
    Property Value
    Type
    ExportSettings

    FirstSelectionIndicatorStyle

    Gets or sets the selection indicator style for the first selecteditem.

    Declaration
    public Style FirstSelectionIndicatorStyle { get; set; }
    Property Value
    Type
    System.Windows.Style

    GetDrawTypeCommand

    Gets or sets the getdrawtypecommand to invoke when draw a object via drawingtool to decide the drawing object.

    Declaration
    public ICommand GetDrawTypeCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    GetLayoutInfoCommand

    Gets or sets the getlayoutcommand to invoke when changes occurs in layout.

    Declaration
    public ICommand GetLayoutInfoCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand
    Remarks

    GetLayoutInfoCommand fires only for Organization layout type.

    Groups

    Gets or sets the IGroup collection of the diagram.

    Declaration
    public object Groups { get; set; }
    Property Value
    Type
    System.Object

    HasChanges

    Gets or sets a value indicating whether the diagram has any unsaved changes since the last save.

    Declaration
    public bool HasChanges { get; set; }
    Property Value
    Type Description
    System.Boolean

    true, if the document has unsaved changes; otherwise, false.

    HistoryChangedCommand

    Occurs every time when there is a history entry change in the history stack of the HistoryManager.

    Declaration
    public ICommand HistoryChangedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    HistoryManager

    Gets or sets the history of the diagram pages which used to log the custom datas.

    Declaration
    public HistoryManager HistoryManager { get; set; }
    Property Value
    Type
    HistoryManager

    HitPadding

    Gets or sets when the port should be visible.

    Declaration
    public double HitPadding { get; set; }
    Property Value
    Type
    System.Double

    HorizontalRuler

    Gets or sets the horizontal ruler of the diagram.

    Declaration
    public Ruler HorizontalRuler { get; set; }
    Property Value
    Type
    Ruler

    Info

    Gets or sets the info of the SfDiagram control.

    Declaration
    public object Info { get; set; }
    Property Value
    Type
    System.Object

    ItemAddedCommand

    Gets or sets the itemaddedcommand to invoke when the item is added to diagram.

    Declaration
    public ICommand ItemAddedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    ItemAddingCommand

    Occurs before an item is added to the SfDiagram.

    Declaration
    public ICommand ItemAddingCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    ItemDeletedCommand

    Gets or sets the itemdeletedcommand to invoke when the element is Deleted.

    Declaration
    public ICommand ItemDeletedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    ItemDeletingCommand

    Gets or sets the itemdeletingcommand to invoke when the element goes for delete.

    Declaration
    public ICommand ItemDeletingCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    ItemDoubleTappedCommand

    Gets or sets the itemdoubletappedcommand to invoke when double click on the diagram or diagram elements.

    Declaration
    public ICommand ItemDoubleTappedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    ItemSelectedCommand

    Gets or sets the itemselectedcommand to invoke when select the diagram elements.

    Declaration
    public ICommand ItemSelectedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    ItemSelectingCommand

    Gets or sets the itemselectingcommand when the element goes for select.

    Declaration
    public ICommand ItemSelectingCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    ItemTappedCommand

    Gets or sets the itemtappedcommand to invoke when click on the diagram or diagram elements.

    Declaration
    public ICommand ItemTappedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    ItemUnSelectedCommand

    Gets or sets the itemunselectedcommand to invoke when the selection goes to unselection.

    Declaration
    public ICommand ItemUnSelectedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    ItemUnSelectingCommand

    Gets or sets the itemunselectingcommand when the element goes for unselect.

    Declaration
    public ICommand ItemUnSelectingCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    KnownTypes

    Gets or sets the knowntypes of the diagram elements properties for serialization.

    Declaration
    public GetTypes KnownTypes { get; set; }
    Property Value
    Type
    GetTypes

    LaneDropIndicatorStyle

    Gets or sets the drop indicator style for the Lane.

    Declaration
    public Style LaneDropIndicatorStyle { get; set; }
    Property Value
    Type
    System.Windows.Style

    LayoutManager

    Gets or sets the layoutmanager of the diagram to manage layouts.

    Declaration
    public LayoutManager LayoutManager { get; set; }
    Property Value
    Type
    LayoutManager

    LayoutUpdatedCommand

    Gets or sets the refreshlayoutcommand to invoke when the layout is changed.

    Declaration
    public ICommand LayoutUpdatedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    LineRoutingSettings

    Gets or sets the LineRoutingSettings to customize the routing.

    Declaration
    public LineRoutingSettings LineRoutingSettings { get; set; }
    Property Value
    Type
    LineRoutingSettings

    Menu

    Gets or sets some additional menu items for contentmenu.

    Declaration
    public DiagramMenu Menu { get; set; }
    Property Value
    Type
    DiagramMenu

    MenuItemClickedCommand

    Gets or sets the menuitemclickedcommand to invoke when a DiagramMenuItem is clicked..

    Declaration
    public ICommand MenuItemClickedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    MenuItemCommand

    Gets or sets the Menuitem command of the Diagram.

    Declaration
    public ICommand MenuItemCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    MenuOpeningCommand

    Gets or sets the menuopeningcommand to invoke when any context menu on the element is opened.

    Declaration
    public ICommand MenuOpeningCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    Model

    Gets or sets the model to generate the diagram.

    Declaration
    public object Model { get; set; }
    Property Value
    Type
    System.Object
    Remarks

    Currently, we are only providing model support for UML sequence diagram.

    MouseDownCommand

    Gets or sets the mousedowncommand to invoke when the mouse pointer is over the control and a mouse button is pressed.

    Declaration
    public ICommand MouseDownCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    MouseUpCommand

    Gets or sets the mouseupcommand to invoke when the mouse pointer is over the control and a mouse button is released.

    Declaration
    public ICommand MouseUpCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    MultipleSelectionMode

    Gets or sets the MultipleSelectionMode of the Diagram.

    Declaration
    public MultipleSelectionMode MultipleSelectionMode { get; set; }
    Property Value
    Type
    MultipleSelectionMode

    NodeChangedCommand

    Gets or sets the nodechangedcommand to invoke when the node is changed.

    Declaration
    public ICommand NodeChangedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    NodeDropIndicatorStyle

    Gets or sets the drop indicator style for the node.

    Declaration
    public Style NodeDropIndicatorStyle { get; set; }
    Property Value
    Type
    System.Windows.Style

    Nodes

    Gets or sets the INode collection of the diagram.

    Declaration
    public object Nodes { get; set; }
    Property Value
    Type
    System.Object

    NodeSelectionIndicatorStyle

    Gets or sets the selection indicator style for the node.

    Declaration
    public Style NodeSelectionIndicatorStyle { get; set; }
    Property Value
    Type
    System.Windows.Style

    ObjectDrawnCommand

    Gets or sets the objectdrawncommand to invoke when the draw a element in the diagram.

    Declaration
    public ICommand ObjectDrawnCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    OutlineSettings

    Gets or sets the OutlineSettings is used to display the mirror images for the outside viewport elements to avoid the empty elements in virtualization Mode.

    Declaration
    public IOutlineSettings OutlineSettings { get; set; }
    Property Value
    Type
    IOutlineSettings

    Page

    Gets ore sets the page of the diagram control where the diagram elements of Node, Connector, ports or etc., can be view.

    Declaration
    public Panel Page { get; }
    Property Value
    Type
    System.Windows.Controls.Panel

    PageSettings

    Gets or sets the size and appearance of the diagram pages.

    Declaration
    public IPageSettings PageSettings { get; set; }
    Property Value
    Type
    IPageSettings

    PortChangedCommand

    Gets or sets the portchanged command to invoke when the port is changed.

    Declaration
    public ICommand PortChangedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    PortHoverEffect

    Gets or sets the animation effect while hovering the mouse on the port.

    Declaration
    public PortHoverEffect PortHoverEffect { get; set; }
    Property Value
    Type Description
    PortHoverEffect

    The default animation effect will be Ripple.

    PortVisibility

    Gets or sets when the port should be visible.

    Declaration
    public PortVisibility PortVisibility { get; set; }
    Property Value
    Type
    PortVisibility

    PreviewSettings

    Gets or sets the size and appearance of the diagram pages.

    Declaration
    public PreviewSettings PreviewSettings { get; set; }
    Property Value
    Type
    PreviewSettings

    PrintingCommand

    Gets or sets the printing command to invoke when print the diagram.

    Declaration
    public ICommand PrintingCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    PrintingService

    Gets or sets whether register or unregister a printing task of the diagram.

    Declaration
    public PrintingService PrintingService { get; set; }
    Property Value
    Type
    PrintingService

    ResizerConstraints

    Gets or sets the default resizer behaviors of the Node/Group.

    Declaration
    public ResizerConstraints ResizerConstraints { get; set; }
    Property Value
    Type
    ResizerConstraints

    ScrollSettings

    Gets or sets the ScrollSettings of the diagram to customize the scrolling.

    Declaration
    public ScrollSettings ScrollSettings { get; set; }
    Property Value
    Type
    ScrollSettings

    ScrollViewerRenderMode

    Gets or sets the ScrollViewerRenderMode of the diagram.

    Declaration
    public ScrollViewerRenderMode ScrollViewerRenderMode { get; set; }
    Property Value
    Type
    ScrollViewerRenderMode

    SelectedItems

    Gets or sets the object shows the selected items of the diagram.

    Declaration
    public object SelectedItems { get; set; }
    Property Value
    Type
    System.Object

    SelectorChangedCommand

    Gets or sets the selectorchangedcommand to invoke when the selection with their porperty value is changed.

    Declaration
    public ICommand SelectorChangedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    SelectorHandleDisplayMode

    Gets or sets the display mode for the handle of the selector.

    Declaration
    public SelectorHandleDisplayMode SelectorHandleDisplayMode { get; set; }
    Property Value
    Type
    SelectorHandleDisplayMode

    SingleSelectionMode

    Gets or sets the selection behavior of diagram elements either single select or toggle select.

    Declaration
    public SingleSelectionMode SingleSelectionMode { get; set; }
    Property Value
    Type
    SingleSelectionMode

    SnapSettings

    Gets or sets the SnapSettings of the Diagram.

    Declaration
    public SnapSettings SnapSettings { get; set; }
    Property Value
    Type
    SnapSettings

    SwimlaneChildChangedCommand

    Gets or sets the SwimlaneChildchangedcommand to invoke when the node is changed.

    Declaration
    public ICommand SwimlaneChildChangedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    Swimlanes

    Gets or sets the ISwimlane collection of the diagram.

    Declaration
    public object Swimlanes { get; set; }
    Property Value
    Type
    System.Object

    Theme

    Gets or sets the theme to a collection of property settings that allow you to define the look of stencil elements.

    Declaration
    public DiagramTheme Theme { get; set; }
    Property Value
    Type
    DiagramTheme

    Tool

    Gets or sets the desired drawing tool of the diagram.

    Declaration
    public Tool Tool { get; set; }
    Property Value
    Type
    Tool

    VerticalRuler

    Gets or sets the vertical ruler of the diagram.

    Declaration
    public Ruler VerticalRuler { get; set; }
    Property Value
    Type
    Ruler

    ViewPortChangedCommand

    Gets or sets the viewportchangedcommand to invoke when the diagram bounds is changed.

    Declaration
    public ICommand ViewPortChangedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    Methods

    CacheAnnotationEditorforItemsOverride(Object, AnnotationEditor)

    Store the AnnotationEditor to stack for recycling.

    Declaration
    protected virtual void CacheAnnotationEditorforItemsOverride(object item, AnnotationEditor view)
    Parameters
    Type Name Description
    System.Object item

    Instance of the IAnnotation.

    AnnotationEditor view

    Store the AnnotationEditor to stack for recycling.

    CacheConnectorBaseforItemsOverride(Object, ConnectorBase)

    Store the Connector or DockPort to stack for recycling.

    Declaration
    protected virtual void CacheConnectorBaseforItemsOverride(object item, ConnectorBase view)
    Parameters
    Type Name Description
    System.Object item

    Instance of viewmodel for connector and dockport.

    ConnectorBase view

    Store the connector or dockport instance to stack for recycling.

    CacheConnectorforItemsOverride(Object, Connector)

    Store the Connector to stack for recycling.

    Declaration
    protected virtual void CacheConnectorforItemsOverride(object item, Connector view)
    Parameters
    Type Name Description
    System.Object item

    Instance of the IConnector.

    Connector view

    Store the Connector instance to stack for recycling.

    CacheContainerHeaderforItemsOverride(Object, ContainerHeader)

    Store the ContainerHeader to the stack for recycling.

    Declaration
    protected virtual void CacheContainerHeaderforItemsOverride(object item, ContainerHeader view)
    Parameters
    Type Name Description
    System.Object item

    Instance of the IContainerHeader.

    ContainerHeader view

    Header to be stored to stack for recycling.

    CacheContextMenuforItemOverride(ContextMenu)

    Store the System.Windows.Controls.ContextMenu element to stack for recycling.

    Declaration
    protected virtual void CacheContextMenuforItemOverride(ContextMenu view)
    Parameters
    Type Name Description
    System.Windows.Controls.ContextMenu view

    Store the view instance to stack for recycling.

    CacheGroupforItemsOverride(Object, Group)

    Store the Group to stack for recycling.

    Declaration
    protected virtual void CacheGroupforItemsOverride(object item, Group view)
    Parameters
    Type Name Description
    System.Object item

    Instance of the IGroup.

    Group view

    Store the Group instance to stack for recycling.

    CacheheaderforItemsOverride(Object, SwimlaneHeader)

    Store the SwimlaneHeader to stack for recycling.

    Declaration
    protected virtual void CacheheaderforItemsOverride(object item, SwimlaneHeader view)
    Parameters
    Type Name Description
    System.Object item

    Instance of the ISwimlaneHeader.

    SwimlaneHeader view

    Store the Header to stack for recycling.

    CacheLaneforItemsOverride(Object, Lane)

    Store the Lane to stack for recycling.

    Declaration
    protected virtual void CacheLaneforItemsOverride(object item, Lane view)
    Parameters
    Type Name Description
    System.Object item

    Instance of the ILane.

    Lane view

    Store the Lane to stack for recycling.

    CacheMenuItemforItemsOverride(MenuItem)

    Store the System.Windows.Controls.MenuItem element to stack for recycling.

    Declaration
    protected virtual void CacheMenuItemforItemsOverride(MenuItem view)
    Parameters
    Type Name Description
    System.Windows.Controls.MenuItem view

    Parameter to store the menuitem instance to stack for recycling.

    CacheNodeforItemsOverride(Object, Node)

    Store the Node to stack for recycling.

    Declaration
    protected virtual void CacheNodeforItemsOverride(object item, Node view)
    Parameters
    Type Name Description
    System.Object item

    Instance of the INode.

    Node view

    Store the Node to stack for recycling.

    CachePhaseforItemsOverride(Object, Phase)

    Store the Phase to stack for recycling.

    Declaration
    protected virtual void CachePhaseforItemsOverride(object item, Phase view)
    Parameters
    Type Name Description
    System.Object item

    Instance of the IPhase.

    Phase view

    Store the Lane to stack for recycling.

    CachePortforItemsOverride(Object, PortBase)

    Store the IPort to stack for recycling.

    Declaration
    protected virtual void CachePortforItemsOverride(object item, PortBase view)
    Parameters
    Type Name Description
    System.Object item

    Instance of the NodePortViewModel or DockPortViewModel or ConnectorPortViewModel.

    PortBase view

    Store the IPort instance to stack for recycling.

    CacheSegmentDecoratorforItemsOverride(Path)

    Store the System.Windows.Shapes.Path to stack for recycling.

    Declaration
    protected virtual void CacheSegmentDecoratorforItemsOverride(Path view)
    Parameters
    Type Name Description
    System.Windows.Shapes.Path view

    Store the new path instance to stack for recycling.

    CacheSeparatorforItemOverride(Separator)

    Store the System.Windows.Controls.Separator element to stack for recycling.

    Declaration
    protected virtual void CacheSeparatorforItemOverride(Separator separator)
    Parameters
    Type Name Description
    System.Windows.Controls.Separator separator

    Parameter to store the seperator instance to stack for recycling.

    CacheSwimlaneforItemsOverride(Object, Swimlane)

    Store the Swimlane to stack for recycling.

    Declaration
    protected virtual void CacheSwimlaneforItemsOverride(object item, Swimlane view)
    Parameters
    Type Name Description
    System.Object item

    Instance of the ISwimlane.

    Swimlane view

    Store the Swimlane to stack for recycling.

    CanExecuteCommand(ICommand)

    This method is used to decide whether commands can execute or not at application level.

    Declaration
    protected virtual bool CanExecuteCommand(ICommand command)
    Parameters
    Type Name Description
    System.Windows.Input.ICommand command

    Instance of System.Windows.Input.ICommand

    Returns
    Type
    System.Boolean

    CanLogHistoryEntry(LogDataArgs)

    Determines whether the data is log into undo/redo stack.

    Declaration
    protected virtual bool CanLogHistoryEntry(LogDataArgs item)
    Parameters
    Type Name Description
    LogDataArgs item

    A log dataLogDataArgs.

    Returns
    Type Description
    System.Boolean

    Returns true, if the data is log into Undo/redo stack;otherwise, false.

    ClearConnectorForItemOverride(Connector, Object)

    Clear the DataContext for Connector.

    Declaration
    protected virtual void ClearConnectorForItemOverride(Connector element, object item)
    Parameters
    Type Name Description
    Connector element

    Element used to display the specified item.

    System.Object item

    Specified item.

    ClearContextMenuForItemOverride(ContextMenu)

    Clear the DataContext for System.Windows.Controls.ContextMenu.

    Declaration
    protected virtual void ClearContextMenuForItemOverride(ContextMenu element)
    Parameters
    Type Name Description
    System.Windows.Controls.ContextMenu element

    Element used to display the specified item.

    ClearGroupForItemOverride(Group, Object)

    Clear the DataContext for Group.

    Declaration
    protected virtual void ClearGroupForItemOverride(Group element, object item)
    Parameters
    Type Name Description
    Group element

    Element used to display the specified item.

    System.Object item

    Specified item.

    ClearHeaderForItemOverride(ContainerHeader, Object)

    Clear the DataContext for ContainerHeader.

    Declaration
    protected virtual void ClearHeaderForItemOverride(ContainerHeader element, object item)
    Parameters
    Type Name Description
    ContainerHeader element

    Element used to display the specified item.

    System.Object item

    Specified item.

    ClearHeaderForItemOverride(SwimlaneHeader, Object)

    Clear the DataContext for SwimlaneHeader.

    Declaration
    protected virtual void ClearHeaderForItemOverride(SwimlaneHeader element, object item)
    Parameters
    Type Name Description
    SwimlaneHeader element

    Element used to display the specified item.

    System.Object item

    Specified item.

    ClearLaneForItemOverride(Lane, Object)

    Clear the DataContext for Lane.

    Declaration
    protected virtual void ClearLaneForItemOverride(Lane element, object item)
    Parameters
    Type Name Description
    Lane element

    Element used to display the specified item.

    System.Object item

    Specified item.

    ClearMenuItemForItemOverride(MenuItem)

    Clear the DataContext for System.Windows.Controls.MenuItem.

    Declaration
    protected virtual void ClearMenuItemForItemOverride(MenuItem element)
    Parameters
    Type Name Description
    System.Windows.Controls.MenuItem element

    Element used to display the specified item.

    ClearNodeForItemOverride(Node, Object)

    Clear the DataContext for Node.

    Declaration
    protected virtual void ClearNodeForItemOverride(Node element, object item)
    Parameters
    Type Name Description
    Node element

    Element used to display the specified item.

    System.Object item

    Specified item.

    ClearPhaseForItemOverride(Phase, Object)

    Clear the DataContext for Phase.

    Declaration
    protected virtual void ClearPhaseForItemOverride(Phase element, object item)
    Parameters
    Type Name Description
    Phase element

    Element used to display the specified item.

    System.Object item

    Specified item.

    ClearSelectorForItemOverride(Selector, Object)

    Clear the DataContext for Selector.

    Declaration
    protected virtual void ClearSelectorForItemOverride(Selector element, object item)
    Parameters
    Type Name Description
    Selector element

    Element used to display the specified item.

    System.Object item

    Specified item.

    ClearSeparatorForItemOverride(Separator)

    clear the DataContext for System.Windows.Controls.Separator.

    Declaration
    protected virtual void ClearSeparatorForItemOverride(Separator separator)
    Parameters
    Type Name Description
    System.Windows.Controls.Separator separator

    Element used to display the specified item.

    ClearSwimlaneForItemOverride(Swimlane, Object)

    Clear the DataContext for Swimlane.

    Declaration
    protected virtual void ClearSwimlaneForItemOverride(Swimlane element, object item)
    Parameters
    Type Name Description
    Swimlane element

    Element used to display the specified item.

    System.Object item

    Specified item.

    CloneDiagramConnector(Object)

    Method to return the clone IConnector element based on the connector collection .

    Declaration
    protected virtual object CloneDiagramConnector(object dragitem)
    Parameters
    Type Name Description
    System.Object dragitem

    Data for the drag item.

    Returns
    Type Description
    System.Object

    Clone item for the drag Connector.

    CloneDiagramElements(Object)

    Method to return the clone INode element based on the node collection .

    Declaration
    protected virtual object CloneDiagramElements(object dragitem)
    Parameters
    Type Name Description
    System.Object dragitem

    Data for the drag item.

    Returns
    Type Description
    System.Object

    Clone item for the drag Node.

    CopyToClipboard()

    Copies Diagram to clipboard.

    Declaration
    public void CopyToClipboard()

    Export()

    This method is used to export the diagram as an Image

    Declaration
    public void Export()

    Export(Int32, Int32)

    This method is used to export the diagram as an Image in a MultiplePage

    Declaration
    public void Export(int rowCount, int columnCount)
    Parameters
    Type Name Description
    System.Int32 rowCount

    Number of row based on page height.

    System.Int32 columnCount

    Number of column based on page width

    GetAnnotationEditorForItemOverride(Object)

    Creates or identifies the AnnotationEditor that is used to display the given IAnnotation.

    Declaration
    protected virtual AnnotationEditor GetAnnotationEditorForItemOverride(object item)
    Parameters
    Type Name Description
    System.Object item

    The object that is actually display in the diagram.

    Returns
    Type Description
    AnnotationEditor

    The element that is used to display the given item.

    GetConnectorBaseForItemOverride(Object)

    Creates or identifies the Connector or DockPort that is used to display the given IConnector or IDockPort.

    Declaration
    protected virtual ConnectorBase GetConnectorBaseForItemOverride(object item)
    Parameters
    Type Name Description
    System.Object item

    The object that is actually display in the diagram.

    Returns
    Type Description
    ConnectorBase

    The element that is used to display the given item.

    GetConnectorForItemOverride(Object)

    Creates or identifies the Connector that is used to display the given IConnector.

    Declaration
    protected virtual Connector GetConnectorForItemOverride(object item)
    Parameters
    Type Name Description
    System.Object item

    The object that is actually display in the diagram.

    Returns
    Type Description
    Connector

    The element that is used to display the given item.

    GetContainerHeaderForItemOverride(Object)

    Creates or identifies the ContainerHeader that is used to display the given IContainerHeader.

    Declaration
    protected virtual ContainerHeader GetContainerHeaderForItemOverride(object item)
    Parameters
    Type Name Description
    System.Object item

    The object that is actually displayed in the diagram.

    Returns
    Type Description
    ContainerHeader

    The element that is used to display the given item.

    GetContextMenuForItemOverride()

    Creates or identifies the view that is used to display the ContextMenu.

    Declaration
    protected virtual ContextMenu GetContextMenuForItemOverride()
    Returns
    Type Description
    System.Windows.Controls.ContextMenu

    Returns a instance of ContextMenu.

    GetGroupForItemOverride(Object)

    Creates or identifies the Group that is used to display the given IGroup.

    Declaration
    protected virtual Group GetGroupForItemOverride(object item)
    Parameters
    Type Name Description
    System.Object item

    The object that is actually display in the diagram.

    Returns
    Type Description
    Group

    The element that is used to display the given item.

    GetHeaderForItemOverride(Object)

    Creates or identifies the SwimlaneHeader that is used to display the given ISwimlaneHeader.

    Declaration
    protected virtual SwimlaneHeader GetHeaderForItemOverride(object item)
    Parameters
    Type Name Description
    System.Object item

    The object that is actually display in the diagram.

    Returns
    Type Description
    SwimlaneHeader

    The element that is used to display the given item.

    GetLaneForItemOverride(Object)

    Creates or identifies the Lane that is used to display the given ILane.

    Declaration
    protected virtual Lane GetLaneForItemOverride(object item)
    Parameters
    Type Name Description
    System.Object item

    The object that is actually display in the diagram.

    Returns
    Type Description
    Lane

    The element that is used to display the given item.

    GetMenuItemForItemsOverride()

    Creates or identifies the view that is used to display the ContextMenu Item.

    Declaration
    protected virtual MenuItem GetMenuItemForItemsOverride()
    Returns
    Type Description
    System.Windows.Controls.MenuItem

    Returns a instance of MenuItem.

    GetNewConnector(Type)

    Creates a new instance of IConnector.

    Declaration
    protected virtual object GetNewConnector(Type desiredType)
    Parameters
    Type Name Description
    System.Type desiredType

    Desired type of IConnector.

    Returns
    Type Description
    System.Object

    Returns a instance of IConnector based on the desired type.

    GetNewGroup(Type)

    Creates a new instance of IGroup.

    Declaration
    protected virtual object GetNewGroup(Type desiredType)
    Parameters
    Type Name Description
    System.Type desiredType

    Desired type of IGroup.

    Returns
    Type Description
    System.Object

    Returns a instance of IGroup based on the desired type.

    GetNewLane(Type)

    Creates a new instance of ILane.

    Declaration
    protected virtual object GetNewLane(Type desiredType)
    Parameters
    Type Name Description
    System.Type desiredType

    Desired type of ILane.

    Returns
    Type Description
    System.Object

    Returns a instance of ILane based on the desired type.

    GetNewNode(Type)

    Creates a new instance of INode.

    Declaration
    protected virtual object GetNewNode(Type desiredType)
    Parameters
    Type Name Description
    System.Type desiredType

    Desired type of INode.

    Returns
    Type Description
    System.Object

    Returns a instance of INode based on the desired type.

    GetNewPhase(Type)

    Creates a new instance of IPhase.

    Declaration
    protected virtual object GetNewPhase(Type desiredType)
    Parameters
    Type Name Description
    System.Type desiredType

    Desired type of IPhase.

    Returns
    Type Description
    System.Object

    Returns a instance of IPhase based on the desired type.

    GetNewPort(Type)

    Creates a new instance of IPort.

    Declaration
    protected virtual object GetNewPort(Type desiredType)
    Parameters
    Type Name Description
    System.Type desiredType

    Desired type of IPort.

    Returns
    Type Description
    System.Object

    Returns a instance of IPort based on the desired type.

    GetNodeForItemOverride(Object)

    Creates or identifies the Node that is used to display the given INode.

    Declaration
    protected virtual Node GetNodeForItemOverride(object item)
    Parameters
    Type Name Description
    System.Object item

    The object that is actually display in the diagram.

    Returns
    Type Description
    Node

    The element that is used to display the given item.

    GetPhaseForItemOverride(Object)

    Creates or identifies the Phase that is used to display the given IPhase.

    Declaration
    protected virtual Phase GetPhaseForItemOverride(object item)
    Parameters
    Type Name Description
    System.Object item

    The object that is actually display in the diagram.

    Returns
    Type Description
    Phase

    The element that is used to display the given item.

    GetPortForItemOverride(Object)

    Creates or identifies the NodePort or ConnectorPort that is used to display the given INodePort or IConnectorPort.

    Declaration
    protected virtual PortBase GetPortForItemOverride(object item)
    Parameters
    Type Name Description
    System.Object item

    The object that is actually display in the diagram.

    Returns
    Type Description
    PortBase

    The element that is used to display the given item.

    GetQuickCommandForItemOverride(Object)

    Creates or identifies the QuickCommand that is used to display the given view model.

    Declaration
    protected virtual QuickCommand GetQuickCommandForItemOverride(object item)
    Parameters
    Type Name Description
    System.Object item

    The quickcommand that is actually display in the diagram.

    Returns
    Type Description
    QuickCommand

    The element that is used to display the given item.

    GetSegmentDecoratorForItemOverride(ISegmentDecorator, out Boolean)

    Creates or identifies the System.Windows.Shapes.Path that is used to display the given ISegmentDecorator.

    Declaration
    protected virtual Path GetSegmentDecoratorForItemOverride(ISegmentDecorator item, out bool isNew)
    Parameters
    Type Name Description
    ISegmentDecorator item

    The ISegmentDecorator that is actually display in the diagram.

    System.Boolean isNew

    Boolean to know whether segment is added newly or not.

    Returns
    Type Description
    System.Windows.Shapes.Path

    The element that is used to display the given item.

    GetSelectorForItemOverride(Object)

    Creates or identifies the Selector that is used to display the given SelectorViewModel.

    Declaration
    protected virtual Selector GetSelectorForItemOverride(object item)
    Parameters
    Type Name Description
    System.Object item

    The object that is actually display the given Selector.

    Returns
    Type Description
    Selector

    The element that is used to display the given item.

    GetSeparatorForItemOverride()

    Creates or identifies the view that is used to separate items in ContextMenu Items.

    Declaration
    protected virtual Separator GetSeparatorForItemOverride()
    Returns
    Type Description
    System.Windows.Controls.Separator

    Returns a instance of Seperator.

    GetSwimlaneForItemOverride(Object)

    Creates or identifies the Swimlane that is used to display the given ISwimlane.

    Declaration
    protected virtual Swimlane GetSwimlaneForItemOverride(object item)
    Parameters
    Type Name Description
    System.Object item

    The object that is actually display in the diagram.

    Returns
    Type Description
    Swimlane

    The element that is used to display the given item.

    Import(Stream)

    Represents a method which is used to add the given elements in the form of steam or xml with already existing elements of diagram control.

    Declaration
    public void Import(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    The stream to which the diagram will be imported.

    Load(Stream)

    Represents a method which is used to load the diagram in the form of stream or xml with cleared the existing elements of diagram control.

    Declaration
    public void Load(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    The stream to which the diagram will be loaded.

    LoadDiagramFromMermaid(String)

    Loads and generates a SfDiagram from the given Mermaid text data.

    Declaration
    public void LoadDiagramFromMermaid(string mermaidText)
    Parameters
    Type Name Description
    System.String mermaidText

    The Mermaid text data used to generate the SfDiagram.

    Remarks

    This method is supported only for diagrams that use the MindMap or Flowchart layout types.

    Examples
    The following example demonstrates how to use the method to load a diagram from Mermaid text format.
    Diagram.LayoutManager = new LayoutManager()
    {
        Layout = new FlowchartLayout()
        {
            Orientation = FlowchartOrientation.TopToBottom,
            YesBranchValues = new List<string> { "Yes", "True", "Y", "s" },
            YesBranchDirection = BranchDirection.LeftInFlow,
            NoBranchValues = new List<string> { "No", "N", "False", "no" },
            NoBranchDirection = BranchDirection.RightInFlow,
            HorizontalSpacing = 60,
            VerticalSpacing = 40,
        },
    };
    Diagram.LoadDiagramFromMermaid(mermaidData);

    OnApplyTemplate()

    Method to apply template values to SfDiagram control.

    Declaration
    public override void OnApplyTemplate()

    OnAutoScroll(AutoScrolledArgs)

    Method to customize the speed and sensitivity of AutoScroll.

    Declaration
    public virtual void OnAutoScroll(AutoScrolledArgs args)
    Parameters
    Type Name Description
    AutoScrolledArgs args

    Provides data's(AutoScrolledArgs) for autoscroll customization.

    OnCreateAutomationPeer()

    Declaration
    protected override AutomationPeer OnCreateAutomationPeer()
    Returns
    Type
    System.Windows.Automation.Peers.AutomationPeer

    OnPropertyChanged(String)

    Invoked whenever the effective value of any dependency property on this FrameworkElement has been updated. The specific dependency property that changed is reported in the arguments parameter. Overrides OnPropertyChanged(name).

    Declaration
    protected virtual void OnPropertyChanged(string name)
    Parameters
    Type Name Description
    System.String name

    PrepareConnectorForItemOverride(Connector, Object)

    Prepares the Connector to display the view model(IConnector).

    Declaration
    protected virtual void PrepareConnectorForItemOverride(Connector element, object item)
    Parameters
    Type Name Description
    Connector element

    Element used to display the specified item.

    System.Object item

    Specified item.

    PrepareContextMenuItemsForItemOverride(DiagramMenuItem, MenuItem)

    Prepares the System.Windows.Controls.MenuItem to display the DiagramMenuItem.

    Declaration
    protected virtual void PrepareContextMenuItemsForItemOverride(DiagramMenuItem element, MenuItem item)
    Parameters
    Type Name Description
    DiagramMenuItem element

    Element used to display the specified item.

    System.Windows.Controls.MenuItem item

    Specified item.

    PrepareGroupForItemOverride(Group, Object)

    Prepares the Group to display the GroupViewModel.

    Declaration
    protected virtual void PrepareGroupForItemOverride(Group element, object item)
    Parameters
    Type Name Description
    Group element

    Element used to display the specified item.

    System.Object item

    Specified item.

    PrepareHeaderForItemOverride(ContainerHeader, Object)

    Prepares the ContainerHeader to display the view model of the Container header.

    Declaration
    protected virtual void PrepareHeaderForItemOverride(ContainerHeader element, object item)
    Parameters
    Type Name Description
    ContainerHeader element

    Element used to display the specified item.

    System.Object item

    Specified item.

    PrepareHeaderForItemOverride(SwimlaneHeader, Object)

    Prepares the SwimlaneHeader to display the view model of the Swimlane header.

    Declaration
    protected virtual void PrepareHeaderForItemOverride(SwimlaneHeader element, object item)
    Parameters
    Type Name Description
    SwimlaneHeader element

    Element used to display the specified item.

    System.Object item

    Specified item.

    PrepareLaneForItemOverride(Lane, Object)

    Prepares the Lane to display the view model of the lane.

    Declaration
    protected virtual void PrepareLaneForItemOverride(Lane element, object item)
    Parameters
    Type Name Description
    Lane element

    Element used to display the specified item.

    System.Object item

    Specified item.

    PrepareNodeForItemOverride(Node, Object)

    Prepares the Node to display the view model of the node.

    Declaration
    protected virtual void PrepareNodeForItemOverride(Node element, object item)
    Parameters
    Type Name Description
    Node element

    Element used to display the specified item.

    System.Object item

    Specified item.

    PreparePhaseForItemOverride(Phase, Object)

    Prepares the Phase to display the viewmodel(IPhase).

    Declaration
    protected virtual void PreparePhaseForItemOverride(Phase element, object item)
    Parameters
    Type Name Description
    Phase element

    Element used to display the specified item.

    System.Object item

    Specified item.

    PrepareQuickCommandForItemOverride(QuickCommand, Object)

    Prepares the QuickCommand to display the IQuickCommand.

    Declaration
    protected virtual void PrepareQuickCommandForItemOverride(QuickCommand element, object item)
    Parameters
    Type Name Description
    QuickCommand element

    Element used to display the specified item.

    System.Object item

    Specified item.

    PrepareSelectorForItemOverride(Selector, Object)

    Prepares the Selector to display the SelectorViewModel.

    Declaration
    protected virtual void PrepareSelectorForItemOverride(Selector element, object item)
    Parameters
    Type Name Description
    Selector element

    Element used to display the specified item.

    System.Object item

    Specified item.

    PrepareSwimlaneForItemOverride(Swimlane, Object)

    Prepares the Swimlane to display the view model of the Swimlane.

    Declaration
    protected virtual void PrepareSwimlaneForItemOverride(Swimlane element, object item)
    Parameters
    Type Name Description
    Swimlane element

    Element used to display the specified item.

    System.Object item

    Specified item.

    Save(Stream)

    Save the diagram into xml or steam for the given stream.

    Declaration
    public void Save(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    The stream to which the diagram will be stored.

    SaveDiagramAsMermaid()

    Serializes the current diagram into Mermaid text format.

    Declaration
    public string SaveDiagramAsMermaid()
    Returns
    Type Description
    System.String

    A string representation of the diagram in Mermaid text format.

    Remarks

    This method is supported only for diagrams that use the MindMap or Flowchart layout types.

    Examples
    The following example demonstrates how to use the method to save a diagram to Mermaid text format.
    Diagram.LayoutManager = new LayoutManager()
    {
        Layout = new FlowchartLayout()
        {
            Orientation = FlowchartOrientation.TopToBottom,
            YesBranchValues = new List<string> { "Yes", "True", "Y", "s" },
            YesBranchDirection = BranchDirection.LeftInFlow,
            NoBranchValues = new List<string> { "No", "N", "False", "no" },
            NoBranchDirection = BranchDirection.RightInFlow,
            HorizontalSpacing = 60,
            VerticalSpacing = 40,
        },
    };
    string mermaidData = Diagram.SaveDiagramAsMermaid();

    SetCursor(SetCursorArgs)

    This method is used to set or customize the cursor for the diagram elements.

    Declaration
    protected virtual void SetCursor(SetCursorArgs args)
    Parameters
    Type Name Description
    SetCursorArgs args

    Instance of SetCursorArgs

    SetTool(SetToolArgs)

    This method is used to set or customize the Tool action for the diagram elements.

    Declaration
    protected virtual void SetTool(SetToolArgs args)
    Parameters
    Type Name Description
    SetToolArgs args

    Instance of SetToolArgs

    Upgrade(Stream)

    Represents a method which is used to upgrade the older diagram into new version of the diagram.

    Declaration
    public void Upgrade(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    The stream to which the diagram will be upgraded

    ValidateConnection(ConnectionParameter)

    Method to validate the connection.

    Declaration
    protected virtual void ValidateConnection(ConnectionParameter args)
    Parameters
    Type Name Description
    ConnectionParameter args

    Instance of ConnectionParameter.

    ValidateControlPoint(ControlPointParameter)

    Initialize virtual method for thumb tool interaction

    Declaration
    protected virtual void ValidateControlPoint(ControlPointParameter args)
    Parameters
    Type Name Description
    ControlPointParameter args

    Instance of ControlPointParameter.

    Events

    PropertyChanged

    Occurs when a property value changes.

    Declaration
    public event PropertyChangedEventHandler PropertyChanged
    Event Type
    Type
    System.ComponentModel.PropertyChangedEventHandler

    Implements

    IGraph
    System.ComponentModel.INotifyPropertyChanged
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved