Class Node
Represents the graphical objects used to visually represent the geometrical information, process flow, internal business procedure, entity, or any other kind of data.
Implements
Namespace: Syncfusion.UI.Xaml.Diagram
Assembly: Syncfusion.SfDiagram.WPF.dll
Syntax
public class Node : ContentControl, INode, IGroupable, INodeView, IView, IDiagramElement, IID, INotifyPropertyChanged, ISharedData, IDisposable
Constructors
Node()
Initializes a new instance of the Node class.
Declaration
public Node()
Fields
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 |
AnnotationsProperty
Using a DependencyProperty as the backing store for Annotations. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty AnnotationsProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
BoundsProperty
Using a DependencyProperty as the backing store for Bounds property. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty BoundsProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ConnectorPaddingProperty
Using a DependencyProperty as the backing store for ConnectorPadding. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty ConnectorPaddingProperty
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 |
FlipModeProperty
Using a DependencyProperty as the backing store for FlipMode. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty FlipModeProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
FlipProperty
Using a DependencyProperty as the backing store for Flip. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty FlipProperty
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 |
IDProperty
Using a DependencyProperty as the backing store for ID. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty IDProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
IsExpandedProperty
Using a DependencyProperty as the backing store for IsExpanded. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty IsExpandedProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
IsSelectedProperty
Using a DependencyProperty as the backing store for IsSelected. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty IsSelectedProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
KeyProperty
Using a DependencyProperty as the backing store for Key. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty KeyProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
LaneOffsetXProperty
Using a DependencyProperty as the backing store for OffsetX. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty LaneOffsetXProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
LaneOffsetYProperty
Using a DependencyProperty as the backing store for OffsetY. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty LaneOffsetYProperty
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 |
OffsetXProperty
Using a DependencyProperty as the backing store for OffsetX. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty OffsetXProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
OffsetYProperty
Using a DependencyProperty as the backing store for OffsetY. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty OffsetYProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ParentGroupProperty
Using a DependencyProperty as the backing store for ParentGroup. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty ParentGroupProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
PivotProperty
Using a DependencyProperty as the backing store for Pivot. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty PivotProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
PortsProperty
Using a DependencyProperty as the backing store for Ports. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty PortsProperty
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 |
RotateAngleProperty
Using a DependencyProperty as the backing store for RotateAngle. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty RotateAngleProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
SearchTagsProperty
Identifies the SearchTags dependency property.
Declaration
public static DependencyProperty SearchTagsProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ShapeProperty
Using a DependencyProperty as the backing store for Shape. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty ShapeProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ShapeStyleProperty
Using a DependencyProperty as the backing store for ShapeStyle. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty ShapeStyleProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
SnapToObjectProperty
Using a DependencyProperty as the backing store for SnapToObject. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty SnapToObjectProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ThemeStyleIdProperty
Using a DependencyProperty as the backing store for ThemeStyleId. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty ThemeStyleIdProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
UnitHeightProperty
Using a DependencyProperty as the backing store for UnitHeight. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty UnitHeightProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
UnitWidthProperty
Using a DependencyProperty as the backing store for UnitWidth. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty UnitWidthProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ZIndexProperty
Using a DependencyProperty as the backing store for ZIndex. This enables animation, styling, binding, etc...
Declaration
public static DependencyProperty ZIndexProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
Properties
AnnotationConstraints
Gets or sets the default behaviors of the annotation.
Declaration
public AnnotationConstraints AnnotationConstraints { get; set; }
Property Value
Annotations
Gets or sets a collection of objects where each object represents a IAnnotation.
Declaration
public object Annotations { get; set; }
Property Value
Type |
---|
System.Object |
BoundingRectangle
Gets or sets the bounding rectangle of the Node.
Declaration
public Rect BoundingRectangle { get; }
Property Value
Type |
---|
System.Windows.Rect |
Bounds
Gets or sets rectangle bouds value of a node.
Declaration
public Rect Bounds { get; }
Property Value
Type |
---|
System.Windows.Rect |
ConnectorPadding
Gets or sets the distance to be left between a Node and its connections(In coming and out going connections).
Declaration
public double ConnectorPadding { get; set; }
Property Value
Type |
---|
System.Double |
Constraints
Gets or sets the default behaviors of the node.
Declaration
public NodeConstraints Constraints { get; set; }
Property Value
Type |
---|
NodeConstraints |
Flip
Gets or sets the object is to be mirrored horizontally, vertically, or both.
Declaration
public Flip Flip { get; set; }
Property Value
Type |
---|
Flip |
FlipMode
Gets or sets the object is to be mirrored horizontally, vertically, or both.
Declaration
public FlipMode FlipMode { get; set; }
Property Value
Type |
---|
FlipMode |
HitPadding
Gets or sets the range of the node selection
Declaration
public double HitPadding { get; set; }
Property Value
Type |
---|
System.Double |
ID
Gets or sets the id of the node.
Declaration
public object ID { get; set; }
Property Value
Type |
---|
System.Object |
Info
Gets or sets info value f Node class.
Declaration
public object Info { get; set; }
Property Value
Type |
---|
System.Object |
IsConnecting
Gets or sets a value indicating whether a node is connecting to any connector or not.
Declaration
public bool IsConnecting { get; set; }
Property Value
Type |
---|
System.Boolean |
IsExpanded
Gets or sets a value indicates whether the node is expanded.
Declaration
public bool IsExpanded { get; set; }
Property Value
Type |
---|
System.Boolean |
IsSelected
Gets or sets a value indicates whether the node is selected. The default value is set to false
Declaration
public bool IsSelected { get; set; }
Property Value
Type |
---|
System.Boolean |
Key
Gets or sets the key of the node.
Declaration
public object Key { get; set; }
Property Value
Type |
---|
System.Object |
LaneOffsetX
Gets or sets the position of the Lane Child on X-Axis.
Declaration
public double LaneOffsetX { get; set; }
Property Value
Type |
---|
System.Double |
LaneOffsetY
Gets or sets the position of the Lane Child on Y-Axis.
Declaration
public double LaneOffsetY { get; set; }
Property Value
Type |
---|
System.Double |
Menu
Gets to Sets the value to define some additional Menu Items.
Declaration
public DiagramMenu Menu { get; set; }
Property Value
Type |
---|
DiagramMenu |
OffsetX
Gets or sets the position of the node on X-Axis.
Declaration
public double OffsetX { get; set; }
Property Value
Type |
---|
System.Double |
OffsetY
Gets or sets the position of the node on Y-Axis.
Declaration
public double OffsetY { get; set; }
Property Value
Type |
---|
System.Double |
ParentGroup
Gets or sets the name of the ParentGroup.
Declaration
public object ParentGroup { get; set; }
Property Value
Type |
---|
System.Object |
Pivot
Gets or sets the ratio/fractional value relative to node, based on which the node will be transformed(positioning, scaling and rotation).
Declaration
public Point Pivot { get; set; }
Property Value
Type |
---|
System.Windows.Point |
Ports
Gets or sets a collection of objects where each object represents a IPort.
Declaration
public object Ports { get; set; }
Property Value
Type |
---|
System.Object |
PortVisibility
Gets or sets when the port should be visible.
Declaration
public PortVisibility PortVisibility { get; set; }
Property Value
Type |
---|
PortVisibility |
RotateAngle
Gets or sets the angle to which the node should be rotated.
Declaration
public double RotateAngle { get; set; }
Property Value
Type |
---|
System.Double |
SearchTags
Gets or sets the search tags of the Node in the Syncfusion.UI.Xaml.Diagram.Stencil.
Declaration
public IEnumerable<string> SearchTags { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> | The list of search tags that are used when you search for the symbol in the Syncfusion.UI.Xaml.Diagram.Stencil. The default is null. |
Shape
Gets or sets the shape of the Node.
Declaration
public object Shape { get; set; }
Property Value
Type |
---|
System.Object |
ShapeStyle
Gets or sets the style of the Node.
Declaration
public Style ShapeStyle { get; set; }
Property Value
Type |
---|
System.Windows.Style |
SnapToObject
Gets or sets the snapping nodes to the object.
Declaration
public SnapToObject SnapToObject { get; set; }
Property Value
Type |
---|
SnapToObject |
ThemeStyleId
Gets or sets the themestyleid of the node
Declaration
public StyleId ThemeStyleId { get; set; }
Property Value
Type |
---|
StyleId |
UnitHeight
Gets or sets the height of the node.
Declaration
public double UnitHeight { get; set; }
Property Value
Type |
---|
System.Double |
UnitWidth
Gets or sets the width of the node.
Declaration
public double UnitWidth { get; set; }
Property Value
Type |
---|
System.Double |
ZIndex
Gets or sets the z-index of the node.
Declaration
public int ZIndex { get; set; }
Property Value
Type |
---|
System.Int32 |
Methods
ArrangeOverride(Size)
Method to arrange Node class elements to given size.
Declaration
protected override Size ArrangeOverride(Size finalSize)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Size | finalSize | Size to arrange elements. |
Returns
Type | Description |
---|---|
System.Windows.Size | Return size. |
GetElementRect(FrameworkElement)
Get the Rect value for the element.
Declaration
public static Rect GetElementRect(FrameworkElement element)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.FrameworkElement | element | element |
Returns
Type | Description |
---|---|
System.Windows.Rect | returns the Rect value |
GetLayoutClip(Size)
Method to get the geometry layout size of Node class.
Declaration
protected override Geometry GetLayoutClip(Size layoutSlotSize)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Size | layoutSlotSize |
Returns
Type | Description |
---|---|
System.Windows.Media.Geometry | Returns null. |
MeasureOverride(Size)
Method to measure size of Node class elements.
Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Size | availableSize | Size to be measure. |
Returns
Type | Description |
---|---|
System.Windows.Size | Return measured size. |
OnApplyTemplate()
Method to apply template values to Node class.
Declaration
public override void OnApplyTemplate()
OnCreateAutomationPeer()
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
Type |
---|
System.Windows.Automation.Peers.AutomationPeer |
OnPropertyChanged(String)
Method for property values are changed for Node class.
Declaration
protected virtual void OnPropertyChanged(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Property name. |
OnSnap(List<SnapParameter>, out Boolean)
Invoked when target objects have been found to snap
Declaration
public virtual void OnSnap(List<SnapParameter> snapParameters, out bool snapAccepted)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<SnapParameter> | snapParameters | Collection of SnapParameters. |
System.Boolean | snapAccepted | Whether the object can be snapped or not |
ShowContextMenu(FrameworkElement, MouseButtonEventArgs)
To show the Node Contect menu.
Declaration
public void ShowContextMenu(FrameworkElement sfDiagram, MouseButtonEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.FrameworkElement | sfDiagram | |
System.Windows.Input.MouseButtonEventArgs | e |
Events
PropertyChanged
Event to notify when property values are changed for Node class.
Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type |
---|
System.ComponentModel.PropertyChangedEventHandler |
Explicit Interface Implementations
INode.get_ContentTemplate()
Declaration
DataTemplate INode.get_ContentTemplate()
Returns
Type |
---|
System.Windows.DataTemplate |
INode.get_MaxHeight()
Declaration
double INode.get_MaxHeight()
Returns
Type |
---|
System.Double |
INode.get_MaxWidth()
Declaration
double INode.get_MaxWidth()
Returns
Type |
---|
System.Double |
INode.get_MinHeight()
Declaration
double INode.get_MinHeight()
Returns
Type |
---|
System.Double |
INode.get_MinWidth()
Declaration
double INode.get_MinWidth()
Returns
Type |
---|
System.Double |
INode.set_ContentTemplate(DataTemplate)
Declaration
void INode.set_ContentTemplate(DataTemplate value)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DataTemplate | value |
INode.set_MaxHeight(Double)
Declaration
void INode.set_MaxHeight(double value)
Parameters
Type | Name | Description |
---|---|---|
System.Double | value |
INode.set_MaxWidth(Double)
Declaration
void INode.set_MaxWidth(double value)
Parameters
Type | Name | Description |
---|---|---|
System.Double | value |
INode.set_MinHeight(Double)
Declaration
void INode.set_MinHeight(double value)
Parameters
Type | Name | Description |
---|---|---|
System.Double | value |
INode.set_MinWidth(Double)
Declaration
void INode.set_MinWidth(double value)
Parameters
Type | Name | Description |
---|---|---|
System.Double | value |
IDisposable.Dispose()
Declaration
void IDisposable.Dispose()