What's New in this Release

The list below describes recent changes and additions to WpfDiagram:

New in version 4.1.5

• TabbedDiagramView no longer interprets underscores in Title property of pages as ALT shortcut, drawing them as is now.
• Fix for ItemRemoved being raised twice.

New in version 4.1.4

• Set EnableVirtualization to false to stop DiagramView's UI virtualization, trading time for presenter creation when scrolling with up-front time to create presenters for all diagram items.
• DiagramView now honors HorizontalContentAlignment and VerticalContentAlignment properties inherited from base Control class, letting you align or center a smaller diagram inside the view.
• Fixed exception when item's ToolTip property is set to a System.Windows.Controls.ToolTip instance rather than a string.
• DataContext of a ToolTip control assigned to items is set to the item that displays it.
• New Export overload of SvgExporter lets you export an already rendered part of DiagramView quicker than overloads taking Diagram argument.

New in version 4.1.3

• Fixed exception thrown when a custom node template contains TextRun objects.

New in version 4.1.2

• DividerPen property added to ContainerNode, TableNode and TreeViewNode classes. It lets you customize the appearance of the divider line drawn between a node's caption bar and content area.
• PatternRouter no longer ignores containers whose Obstacle property is enabled.
• Unfolding a ContainerNode now always restores original size from UnfoldedSize property, regardless of AutoGrow and AutoShrink values. To revert to old behavior, call ResizeToFitChildren from ContainerUnfolded event handler.
• Fixed rendering of RoundedLinks with larger StrokeThickness.
• Fix for tooltips not closing when the mouse pointer moves outside of the DiagramView.
• Minimum required .NET Framework version lowered from 4.7.2 to 4.6.2.

New in version 4.1.1

Export XPS files

The XpsExporter class from MindFusion.Diagramming.Wpf.XpsExport.dll assembly exports diagrams to XPS (XML Paper Specification) files. The Export method overloads let you export either Diagram or DiagramDocument objects.

Miscellaneous

• The ToolTipDelay property lets you specify the delay in milliseconds before showing an item's tool-tip.
• DiagramLink tool-tip fixes.
• Fix for node presenter not disappearing until next WPF layout pass if UIElement.UpdateLayout is called from NodeDeleted.
• Fixed ContainerNode rotation when RotationStep is set.
• Fixed ContainerNode rotation for children added using GroupAnchorStyles or AttachToNode flags.

New in version 4.1

Support for custom in-place edit controls

Handle the CreateEditControl event to display a custom WPF control for users to edit item's content. This event is raised when entering in-place editing mode, either interactively by users or by calling the BeginEdit method. You could handle the event to return a composite control for editing many of the item's properties, and not only text. When leaving in-place editing mode, the DiagramView raises DestroyEditControl to let you copy to the item any values entered by the user and close the custom editor.

New mouse events

• NodePointerEnter and NodePointerLeave are raised when the mouse pointer respectively enters or leaves the boundaries of a node. NodeHovered fires if the pointer rests over a node for HoverDelay milliseconds.
• LinkPointerEnter and LinkPointerLeave are raised when the mouse pointer respectively enters or leaves the boundaries of a link. LinkHovered fires if the pointer rests over a link for HoverDelay milliseconds.

Miscellaneous

• ScrollWheelDelta and ScrollClickDelta properties let you customize the amount by which the view scroll position changes when users scroll using the mouse wheel or by clicking scrollbar arrows.
• Handle the CreateToolTipControl event to create custom ToolTip instances.
• AutoHandlesItem and AutoAnchorsNode properties return the items that currently display automatic adjustment handles or anchor points.
• Fixed SvgExporter and PdfExporter memory leaks.
• Fixed exceptions in SvgExporter for some text symbols.

API changes

• The TextBox property of InPlaceEditEventArgs has been renamed to EditControl, and its type changed from TextBox to base Control type.

New in version 4.0.9

• JsonImageHandler lets you serialize custom image sources to JSON format.
• The control automatically shows ContextMenu of right-clicked objects. It also raises NodeMenuOpening, LinkMenuOpening and ContextMenuOpening validation events to let you cancel the operation selectively.
• Fix for incomplete layout by Print and PrintPreview methods of DiagramDocument.

New in version 4.0.8

• New LinkDensity partitioning method added to CompositeLayout, divides the graph depending on ratio of nodes to links in subgraphs.
• AnnealLayout now normalizes distance calculations, making its cost property values independent from diagram's MeasureUnit.
• Enable the FlipImage property of ShapeNode to make node's Image follow the geometric shape mirroring specified by FlipX and FlipY properties.
• Set the AutoDeleteLinks property to false to prevent deleting links along with a node they connect, and disconnect the links instead.

New in version 4.0.7

Custom anchor point / pattern classes

The control now supports serialization of custom AnchorPoint and AnchorPattern -derived objects. Call the RegisterClass method to specify XML or JSON type identifiers of the custom classes. Override SaveToXml and LoadFromXml to serialize custom properties in XML format. Override SaveToJson and LoadFromJson to serialize custom properties in JSON format. Custom classes must also implement no-argument and copy constructors.

Miscellaneous

• JsonSerializeTag event is now raised when serializing AnchorPoint Tag values in JSON format.
• Fix for Disallow* mouse cursors not showing.
• Fix for custom table cell templates not rendering in version 4 DiagramView.
• Fix for CreateImage exporting nodes at zero position.

New in version 4.0.6

.NET 8 support

The distribution now includes assemblies and sample projects for .NET 8. Locally installed assemblies do not appear automatically in Visual Studio toolbox at this time; you can either add references manually or through Nuget package manager.

UI virtualization improvements

• The Overview control now virtualizes items when its ScaleMode is different from FitAll.
• Large ContainerNodes that cover several screens now create presenters only for Children inside current DiagramView viewport.

Miscellaneous

• Drag-and-drop ghost image now displays custom node templates.
• Fix for item interactions starting on mouse-down event, instead of first mouse-move as in version 3 of the diagram.

New in version 4.0.5

• Fix for custom templates not showing NodeRenderer in new DiagramView.
• Fixed exception when Scrollable containers are nested.
• Fixed exception when (programmatically) moving offscreen containers.

New in version 4.0.4

NodeListView improvements

• The IconSize property specifies the size of node icons displayed by NodeListView.
• DefaultNodeSize specifies default size of nodes created by dragging from NodeListView.
• Fixed NodeListView exception when hosted in a third-party accordion control.

ItemLabel improvements

• Item labels can now by styled using global styles whose TargetType is set to NodeLabel or LinkLabel.
• ItemLabel JSON serialization fixes.
• Fixed exception when EnableWrap is set without specifying label's MaxWidth.
• Fixed label hit-testing when spatial indexing is enabled.

New in version 4.0.3

• Fix for DiagramLink in-place editor opening at incorrect position.

New in version 4.0.2

Drag-and-drop improvements

• The control now displays a ghost image of nodes dragged from NodeListView. Set the DragIndicatorOpacity property to set the image opacity.
• Set HorizontalDropAlignment and VerticalDropAlignment to specify placement of dropped node relative to mouse pointer

Miscellaneous

• Set LayerTowardsStart property of LayeredLayout to place child nodes closer to parent nodes.
• Call CloseToolTip method if you need to hide tooltips explicitly.
• Fixed MouseInputMode of ControlNode when using new DiagramView.
• Small performance improvements.

New in version 4.0.1

• Fixed UI virtualization memory leaks.
• Fix for NodeListView not drawing supplementary labels in version 4.
• RemoveLabel now automatically repaints the node.
• OriginAnchor and DestinationAnchor setters now realign segments of cascading links.
• Fix for selection lasso not always rendering inside DiagramView.
• Fix for HorizontalScaleHeight and VerticalScaleWidth setters not updating the Ruler.
• SnapMarksToPixels and MarkLength properties added to Ruler control.

New in version 4

Model / view separation

Diagram is now considered a model class and must be displayed inside DiagramView control. DiagramView contains a built-in ScrollViewer, so updating applications to this version should be a matter of replacing old ScrollViewer with new DiagramView, and using zoom, scroll and behavior properties of the view object instead of diagram one.

For compatibility with legacy code, Diagram still inherits from Control and can be used on its own for time being, but following new features are only available through the new DiagramView class. In addition, view-related properties of Diagram, such as ZoomFactor, Scroll position, Behavior, are now marked as obsolete and will display compile warnings when used.

UI virtualization

DiagramView and ContainerNode add UI elements to WPF visual tree only for diagram items they are currently visible in respective viewports. This should improve diagram's rendering / refresh speed.

Note that rendering speed improves only when showing a smaller part of the diagram inside DiagramView's viewport. Rendering a lot of items at small zoom levels or in overview's fit-all mode will still need a lot of processing, so you might want to apply constraints on minimal zoom level of diagram view and overview controls for large diagrams.

Spatial index

Set the EnableSpatialIndex property of Diagram to create an index of item positions for faster hit-testing and viewport clipping queries. When combined with UI virtualization, this should greatly improve user interaction and rendering speed for diagrams containing tens of thousands or more items.

C#

// create 20000 links + nodes in total
for (int i = 0; i < 10000; i++)
{
    var node = diagram.Factory.CreateShapeNode(x, y, size, size);
    node.Text = i.ToString();
    if (x > diagram.Bounds.Left)
    {
        diagram.Factory.CreateDiagramLink(
        diagram.Nodes[i - 1], diagram.Nodes[i]);
    }

    x += dist;
    if (x >= diagram.Bounds.Right)
    {
        x = diagram.Bounds.Left;
        y += dist;
    }
}

diagram.EnableSpatialIndex = true;

Multi-touch support

DiagramView handles WPF touch events and implements multitouch gestures that can be controlled via following properties:

• If MultiTouchZoom property is enabled (default), the view can be zoomed or panned using two-touch pinch / flick gestures.
• If MultiTouchModify property is enabled (default), diagram nodes can be moved, scaled and rotated using two-touch pinch / flick gestures.
• If MultiTouchZoom property is disabled, each touch draws diagram items corresponding to current behavior.
• If MultiTouchModify property is disabled, each touch started from a node draws a diagram link.
• Latter modes can be used for collaborative whiteboarding / classroom scenarios.
• Setting MultiTouchDraw to false lets you prevent drawing multiple items simultaneously, while keeping other multitouch gestures enabled.
• If MultiTouchDraw is enabled (default), a second touch will still cancel first-touch drawing if added within TouchGestureInterval time and TouchGestureDistance distance, and start a multi-touch gesture.
• Additional TouchHitDistance property makes it easier to grab adjustment handles on touch screens, without increasing the AdjustmentHandlesSize value.

Async serialization

Files can now be saved and loaded asynchronously. Async methods create a copy of the diagram to process it in a worker thread, and custom item classes must implement Clone method or copy constructor in order to serialize them as expected.

• async SaveToXmlAsync and LoadFromXmlAsync methods of Diagram and DiagramDocument implement serialization in XML format.
• async SaveToJsonFileAsync, SaveToJsonAsync, LoadFromJsonFileAsync, LoadFromJsonAsync methods of Diagram and DiagramDocument implement serialization in JSON format.

Miscellaneous

• PageMoved and PageRenaming events added to TabbedDiagramView control.
• Different arrowhead shapes can be filled with distinct brushes as set through HeadBrush, BaseBrush and IntermediateBrush.
• DiagramDocument JSON serialization methods.
• Selectively prevent adding or removing child nodes to/from a container by handling the ContainerChildAdding and ContainerChildRemoving events.
• FoldIconSize property added to ContainerNode.
• Clone methods of Diagram and DiagramDocument return a copy of the diagram / document and its items.
• Fix for ShapeNode.Clone not copying ImagePadding value.
• Set GridPatternHatch and GridPatternThreshold to replace alignment grid with hatch pattern at low zoom levels for faster drawing.
• More precise baseline alignment in exported SVG texts.
• SvgNode parser now supports multiple class names in the "class" attribute of SVG elements.
• Fixed CreateImage results when called with Windows display scaling enabled.

API changes

• Diagram should now be hosted inside DiagramView. For time being it can still be used as a standalone control, but support for this will be removed in a future release.
• Set Behavior, ZoomFactor, Scroll*, *ButtonActions properties of DiagramView instead of Diagram.
• Instead of setting Document property of Overview to a Diagram instance, set its DiagramView property.
• Instead of setting Document property of Ruler to a Diagram instance, set its DiagramView property. The latter is the default content property now. If you still need to show stand-alone diagram inside Ruler from Xaml, you must explicitly set it through <diag:Ruler.Document> tag.
• For consistency with other MindFusion diagram libraries, DiagramNodeAdapter has been renamed to ControlNode. Its UIElement property has been renamed to Control.