menu

WinForms

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

    Show / Hide Table of Contents

    Class Node

    Abstract class that implement base methods that used to transform and visualize diagram objects. Implement moving, rotating, scaling, hittesting and serialization.

    Inheritance
    System.Object
    Node
    BitmapNode
    ControlNode
    Group
    MetafileNode
    PathNode
    RichTextNode
    Shape
    Symbol
    TextNode
    Implements
    IUnitIndependent
    IDispatchNodeEvents
    System.Runtime.Serialization.ISerializable
    INode
    System.ICloneable
    IServiceReferenceHolder
    IServiceReferenceProvider
    IPropertyObserver
    IPropertyContainer
    System.IServiceProvider
    IGraphNode
    System.Runtime.Serialization.IDeserializationCallback
    System.IDisposable
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Syncfusion.Windows.Forms.Diagram
    Assembly: Syncfusion.Diagram.Base.dll
    Syntax
    public abstract class Node : IUnitIndependent, IDispatchNodeEvents, ISerializable, INode, ICloneable, IServiceReferenceHolder, IServiceReferenceProvider, IPropertyObserver, IPropertyContainer, IServiceProvider, IGraphNode, IDeserializationCallback, IDisposable
    Remarks

    This is a basic object on the diagram that can represent connectors, images, text box, controls and other simple shapes.

    Constructors

    Node()

    Initializes a new instance of the Node class.

    Declaration
    public Node()

    Node(Node)

    Initializes a new instance of the Node class.

    Declaration
    public Node(Node src)
    Parameters
    Type Name Description
    Node src

    The SRC.

    Node(SerializationInfo, StreamingContext)

    Initializes a new instance of the Node class.

    Declaration
    protected Node(SerializationInfo info, StreamingContext context)
    Parameters
    Type Name Description
    System.Runtime.Serialization.SerializationInfo info

    The info.

    System.Runtime.Serialization.StreamingContext context

    The context.

    Fields

    m_bLockUpdate

    Lock updates.

    Declaration
    protected bool m_bLockUpdate
    Field Value
    Type
    System.Boolean

    m_bPortUpdating

    Indicate whether node updating self ports connections.

    Declaration
    protected bool m_bPortUpdating
    Field Value
    Type
    System.Boolean

    m_eventSink

    DocumentEventSink reference.

    Declaration
    protected DocumentEventSink m_eventSink
    Field Value
    Type
    DocumentEventSink

    m_fRotationAngle

    Node's rotation angle.

    Declaration
    protected float m_fRotationAngle
    Field Value
    Type
    System.Single

    m_mgrBridge

    Bridge Manager reference.

    Declaration
    protected BridgeManager m_mgrBridge
    Field Value
    Type
    BridgeManager

    m_mgrHistory

    History manager reference.

    Declaration
    protected HistoryManager m_mgrHistory
    Field Value
    Type
    HistoryManager

    m_mgrLink

    Link Manager reference.

    Declaration
    protected LinkManager m_mgrLink
    Field Value
    Type
    LinkManager

    m_rgnCache

    Region used for HitTesting.

    Declaration
    protected Region[] m_rgnCache
    Field Value
    Type
    System.Drawing.Region[]
    Remarks

    Internal usage only.

    Properties

    AllowLabelDrag

    Enable/Disable to Drag the labels in Node

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

    BoundingRectangle

    Gets the shape's bounding box.

    Declaration
    public RectangleF BoundingRectangle { get; }
    Property Value
    Type
    System.Drawing.RectangleF

    BoundsInfo

    Gets the reference to bounds info.

    Declaration
    public BoundsInfo BoundsInfo { get; }
    Property Value
    Type Description
    BoundsInfo

    The bounds info.

    CentralPort

    Gets the center port from port collection.

    Declaration
    public CentralPort CentralPort { get; }
    Property Value
    Type Description
    CentralPort

    The center port.

    Container

    Gets or sets node's container node

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

    DrawPorts

    Gets or sets a value indicating whether node will draw it ports.

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

    true if n node will draw it ports; otherwise, false.

    Edges

    Gets collection of all edges entering or leaving the node.

    Declaration
    public ICollection Edges { get; }
    Property Value
    Type
    System.Collections.ICollection

    EdgesEntering

    Gets collection of edges entering the node.

    Declaration
    public ICollection EdgesEntering { get; }
    Property Value
    Type
    System.Collections.ICollection

    EdgesLeaving

    Gets collection of edges leaving the node.

    Declaration
    public ICollection EdgesLeaving { get; }
    Property Value
    Type
    System.Collections.ICollection

    EditStyle

    Gets edit properties for this node.

    Declaration
    public EditStyle EditStyle { get; }
    Property Value
    Type
    EditStyle
    Remarks

    Edit properties determine how this node can be edited. EditStyle

    EnableCentralPort

    Gets or sets a value indicating whether central port is enabled.

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

    true if central port is enabled; otherwise, false.

    EventSink

    Gets the reference to model event sink.

    Declaration
    protected DocumentEventSink EventSink { get; }
    Property Value
    Type Description
    DocumentEventSink

    The event sink.

    ExcludeFromLayout

    Gets or sets a value indicating whether the node can be excluded from layout or not.

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

    FlipX

    Gets or sets a value indicating whether flip X is enabled.

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

    true if node vertical flipped ; otherwise, false.

    FlipY

    Gets or sets a value indicating whether flip Y is enabled.

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

    true if node horizontal flipped; otherwise, false.

    FullContainerName

    Gets the full name of the container.

    Declaration
    public string FullContainerName { get; }
    Property Value
    Type Description
    System.String

    The full name of the container.

    FullName

    Gets fully qualified name of the node.

    Declaration
    public string FullName { get; }
    Property Value
    Type
    System.String
    Remarks

    The full name is the name of the node concatenated with the names of all parent nodes.

    GraphicsPath

    Gets cloned node GraphicsPath with appended scale transformations.

    Declaration
    public GraphicsPath GraphicsPath { get; }
    Property Value
    Type Description
    System.Drawing.Drawing2D.GraphicsPath

    The graphics path.

    HistoryManager

    Gets the children to model history manager.

    Declaration
    protected HistoryManager HistoryManager { get; }
    Property Value
    Type Description
    HistoryManager

    The history manager.

    InheritContainerMeasureUnits

    Gets or sets a value indicating whether container measure units can be inherited.

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

    true if inherit container measure units; otherwise, false.

    IsExpanded

    Gets or Sets the selected node as expand or collapse.

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

    Layers

    Gets the layers the shape belongs to.

    Declaration
    public LayerCollection Layers { get; }
    Property Value
    Type
    LayerCollection

    LineHitTestPadding

    Gets or sets the line hit test padding.

    Declaration
    public float LineHitTestPadding { get; set; }
    Property Value
    Type Description
    System.Single

    The line hit test padding.

    LineStyle

    Gets line drawing properties for this node.

    Declaration
    public LineStyle LineStyle { get; }
    Property Value
    Type
    LineStyle
    Remarks

    Gets the line style determines the configuration of the pen used to render lines. LineStyle

    LogicalGraphicsPath

    Gets node graphics path without scale transformation.

    Declaration
    protected virtual GraphicsPath LogicalGraphicsPath { get; }
    Property Value
    Type Description
    System.Drawing.Drawing2D.GraphicsPath

    The logical graphics path.

    MeasurementUnit

    Gets or sets the measurement unit.

    Declaration
    public MeasureUnits MeasurementUnit { get; set; }
    Property Value
    Type Description
    MeasureUnits

    The measurement unit.

    Name

    Gets or sets node's name.

    Declaration
    public string Name { get; set; }
    Property Value
    Type
    System.String

    NodeScale

    Gets or sets the node scale.

    Declaration
    public PageScale NodeScale { get; set; }
    Property Value
    Type Description
    PageScale

    The node scale.

    Parent

    Gets or sets node's parent.

    Declaration
    public ICompositeNode Parent { get; set; }
    Property Value
    Type
    ICompositeNode

    PinPoint

    Gets or sets the node pin point position. PinPoint value is considered as the node�s center point.

    Declaration
    public PointF PinPoint { get; set; }
    Property Value
    Type Description
    System.Drawing.PointF

    The value is considered as the node�s center point.

    PinPointOffset

    Gets or sets the node pin point offset.

    Declaration
    public SizeF PinPointOffset { get; set; }
    Property Value
    Type Description
    System.Drawing.SizeF

    The pin point offset.

    Ports

    Gets the node port collection.

    Declaration
    public ConnectionPointCollection Ports { get; }
    Property Value
    Type Description
    ConnectionPointCollection

    The ports.

    PrintPorts

    Gets or sets a value indicating whether node will draw it ports while printing.

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

    true if [print ports]; otherwise, false.

    PropertyBag

    Gets or sets the dynamic property data dictionary.

    Declaration
    public Dictionary<string, object> PropertyBag { get; }
    Property Value
    Type
    System.Collections.Generic.Dictionary<System.String, System.Object>

    RefreshRect

    Gets node's refresh rectangle.

    Declaration
    public RectangleF RefreshRect { get; }
    Property Value
    Type
    System.Drawing.RectangleF

    Root

    Gets the root node in the node hierarchy.

    Declaration
    public Model Root { get; }
    Property Value
    Type
    Model
    Remarks

    The root node is found by following the chain of parent nodes until a node is found that has a NULL parent.

    RotationAngle

    Gets or sets the rotation angle.

    Declaration
    public virtual float RotationAngle { get; set; }
    Property Value
    Type Description
    System.Single

    The rotation angle in range [ -180; 180 ].

    Remarks

    Rotation angle saved in rotation range [ -180; 180 ] But on set this property new rotation angle must be in range [ 0; 360 ]

    ShadowStyle

    Gets properties of the shadow applied to the shape.

    Declaration
    public ShadowStyle ShadowStyle { get; }
    Property Value
    Type
    ShadowStyle

    Size

    Gets or sets size of the node.

    Declaration
    public SizeF Size { get; set; }
    Property Value
    Type
    System.Drawing.SizeF

    Tag

    Gets or sets Custom data associated with Node.

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

    ToolTipText

    Gets or sets the tooltip text associated with the node.

    Declaration
    public string ToolTipText { get; set; }
    Property Value
    Type
    System.String

    TreatAsObstacle

    Gets or sets a value indicating whether node treat as obstacle.

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

    true if need node treat as obstacle; otherwise, false.

    Visible

    Gets or sets a value indicating whether node is visible.

    Declaration
    public virtual bool Visible { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    This flag can be changed to True only if one of its owner layer are visible.

    ZOrder

    Gets or sets node's ZOrder.

    Declaration
    public int ZOrder { get; set; }
    Property Value
    Type
    System.Int32

    Methods

    AccumulateRefreshRect(ref RectangleF)

    Accumulates the refresh rect.

    Declaration
    protected virtual void AccumulateRefreshRect(ref RectangleF rcRefresh)
    Parameters
    Type Name Description
    System.Drawing.RectangleF rcRefresh

    The rc refresh.

    AppendFlipTransforms(Matrix)

    Appends filp transformation to given matrix

    Declaration
    public void AppendFlipTransforms(Matrix matrix)
    Parameters
    Type Name Description
    System.Drawing.Drawing2D.Matrix matrix

    The matrix.

    AppendFlipTransforms(Matrix, PointF, Boolean, Boolean)

    Appends the flip transforms.

    Declaration
    protected void AppendFlipTransforms(Matrix matrix, PointF ptPinPoint, bool bFlipX, bool bFlipY)
    Parameters
    Type Name Description
    System.Drawing.Drawing2D.Matrix matrix

    The matrix.

    System.Drawing.PointF ptPinPoint

    Node's pin point.

    System.Boolean bFlipX

    if set to true flip X will flipped vertical.

    System.Boolean bFlipY

    if set to true flip Y will flipped horizontal.

    AppendLocalFlipTransforms(Matrix)

    Appends filp transformation to given matrix

    Declaration
    public void AppendLocalFlipTransforms(Matrix matrix)
    Parameters
    Type Name Description
    System.Drawing.Drawing2D.Matrix matrix

    The matrix.

    CanUpdateConnections(EndPoint)

    Determines whether this EndPoint can update connections the specified end point.

    Declaration
    protected bool CanUpdateConnections(EndPoint endPoint)
    Parameters
    Type Name Description
    EndPoint endPoint

    The end point.

    Returns
    Type Description
    System.Boolean

    true if this EndPoint can update connections the specified end point; otherwise, false.

    CanWiden(GraphicsPath)

    Determine whether can widen the specified graphics path.

    Declaration
    protected bool CanWiden(GraphicsPath path)
    Parameters
    Type Name Description
    System.Drawing.Drawing2D.GraphicsPath path

    The graphics path.

    Returns
    Type Description
    System.Boolean

    true if can widen the specified graphics path; otherwise, false.

    ChangeFlipX(Boolean)

    Called after change the flipX value.

    Declaration
    protected virtual void ChangeFlipX(bool value)
    Parameters
    Type Name Description
    System.Boolean value

    New flip x value.

    ChangeFlipY(Boolean)

    Called after change the flipY value.

    Declaration
    protected virtual void ChangeFlipY(bool value)
    Parameters
    Type Name Description
    System.Boolean value

    New flip y value.

    ChangeRotationBy(Single)

    Called after change the rotation by give angle.

    Declaration
    protected virtual void ChangeRotationBy(float fRotationChange)
    Parameters
    Type Name Description
    System.Single fRotationChange

    The rotation angle offset.

    CheckConstrainingRegion(PointF)

    Checks the constraining region.

    Declaration
    protected bool CheckConstrainingRegion(PointF ptPoint)
    Parameters
    Type Name Description
    System.Drawing.PointF ptPoint

    The given point.

    Returns
    Type Description
    System.Boolean

    true, if check constraining region

    CheckConstrainingRegion(RectangleF)

    Checks the constraining region.

    Declaration
    protected virtual bool CheckConstrainingRegion(RectangleF bounds)
    Parameters
    Type Name Description
    System.Drawing.RectangleF bounds

    The bounds.

    Returns
    Type Description
    System.Boolean

    true, if check constraining region.

    CheckNewPinPoint(PointF, MeasureUnits)

    Checks the new pin point.

    Declaration
    protected virtual bool CheckNewPinPoint(PointF ptPinPoint, MeasureUnits unit)
    Parameters
    Type Name Description
    System.Drawing.PointF ptPinPoint

    The pin point.

    MeasureUnits unit

    The unit.

    Returns
    Type Description
    System.Boolean

    true if this value can set; otherwise, false.

    Clone()

    Creates a new object that is a copy of the current instance.

    Declaration
    public abstract object Clone()
    Returns
    Type Description
    System.Object

    A new object that is a copy of this instance.

    ContainsPoint(PointF)

    Performs given point hit test.

    Declaration
    public virtual bool ContainsPoint(PointF ptTest)
    Parameters
    Type Name Description
    System.Drawing.PointF ptTest

    Point to test

    Returns
    Type Description
    System.Boolean

    true, if contains point.

    Remarks

    Point must be in pixel units.

    ConvertToModelCoordinates(PointF)

    Converts given point from node's to model's coordinates.

    Declaration
    public PointF ConvertToModelCoordinates(PointF ptToConvert)
    Parameters
    Type Name Description
    System.Drawing.PointF ptToConvert

    Point to convert.

    Returns
    Type Description
    System.Drawing.PointF

    Converted point.

    ConvertToNodeCoordinates(PointF)

    Converts given point from model's to node's coordinates.

    Declaration
    public PointF ConvertToNodeCoordinates(PointF ptToConvert)
    Parameters
    Type Name Description
    System.Drawing.PointF ptToConvert

    Point to convert.

    Returns
    Type Description
    System.Drawing.PointF

    Converted point.

    CreateBoundsInfo(BoundsInfo)

    Creates the bounds info.

    Declaration
    protected void CreateBoundsInfo(BoundsInfo src)
    Parameters
    Type Name Description
    BoundsInfo src

    The primary object.

    CreateBoundsInfo(BoundsInfo, PageScale)

    Creates the bounds info.

    Declaration
    protected void CreateBoundsInfo(BoundsInfo src, PageScale scale)
    Parameters
    Type Name Description
    BoundsInfo src

    The primary object.

    PageScale scale

    The scale.

    CreateBoundsInfo(PointF, SizeF, SizeF)

    Creates the bounds info.

    Declaration
    protected void CreateBoundsInfo(PointF ptPinPoint, SizeF szPinPointOffset, SizeF szSize)
    Parameters
    Type Name Description
    System.Drawing.PointF ptPinPoint

    The pin point position.

    System.Drawing.SizeF szPinPointOffset

    The pin point offset.

    System.Drawing.SizeF szSize

    The size.

    Dispose()

    Declaration
    public virtual void Dispose()

    DoMoveRelatedActions(Single, Single)

    Performs additional changes on pin position changed.

    Declaration
    protected virtual void DoMoveRelatedActions(float fX, float fY)
    Parameters
    Type Name Description
    System.Single fX

    The pin offset by x axis.

    System.Single fY

    The pin offset by y axis.

    DoPinOffsetRelatedActions(SizeF, SizeF)

    Performs additional changes on pin offset value changed.

    Declaration
    protected virtual void DoPinOffsetRelatedActions(SizeF szOldPinOffset, SizeF szNewPinOffset)
    Parameters
    Type Name Description
    System.Drawing.SizeF szOldPinOffset

    The old pin offset value.

    System.Drawing.SizeF szNewPinOffset

    The new pin offset value.

    DoSizeRelatedActions(SizeF, SizeF)

    Performs additional changes on size value changed.

    Declaration
    protected virtual void DoSizeRelatedActions(SizeF szOldSize, SizeF szNewSize)
    Parameters
    Type Name Description
    System.Drawing.SizeF szOldSize

    Old size value.

    System.Drawing.SizeF szNewSize

    New size value.

    Draw(Graphics)

    Draws object to the specified graphics.

    Declaration
    public void Draw(Graphics gfx)
    Parameters
    Type Name Description
    System.Drawing.Graphics gfx

    Graphics to draw on.

    Draw(Graphics, Boolean)

    Draws object to the specified graphics.

    Declaration
    public void Draw(Graphics gfx, bool bExcludeTransformation)
    Parameters
    Type Name Description
    System.Drawing.Graphics gfx

    Graphics to draw on.

    System.Boolean bExcludeTransformation

    if set to true to draws the object without the transformation.

    EventSink_PropertyChanged(PropertyChangedEventArgs)

    Raise when node property changed.

    Declaration
    protected virtual void EventSink_PropertyChanged(PropertyChangedEventArgs evtArgs)
    Parameters
    Type Name Description
    PropertyChangedEventArgs evtArgs

    The PropertyChangedEventArgs instance containing the event data.

    EventSink_PropertyChanging(PropertyChangingEventArgs)

    Raise when node property changing.

    Declaration
    protected virtual void EventSink_PropertyChanging(PropertyChangingEventArgs evtArgs)
    Parameters
    Type Name Description
    PropertyChangingEventArgs evtArgs

    The PropertyChangingEventArgs instance containing the event data.

    GetBoundsRect(Node)

    Gets the cached bounds rectangle from given node.

    Declaration
    protected RectangleF GetBoundsRect(Node node)
    Parameters
    Type Name Description
    Node node

    The node to get BoundRect property value.

    Returns
    Type Description
    System.Drawing.RectangleF

    The bounds.

    GetLocalTransformations()

    Gets local node's transformations.

    Declaration
    public Matrix GetLocalTransformations()
    Returns
    Type Description
    System.Drawing.Drawing2D.Matrix

    The matrix

    GetNodeBounds(Boolean, Boolean)

    Gets the Node bounds with or without the labels or ports

    Declaration
    public virtual RectangleF GetNodeBounds(bool excludeLabel, bool excludePort)
    Parameters
    Type Name Description
    System.Boolean excludeLabel

    if true, include the label bounds, otherwise exclude

    System.Boolean excludePort

    if true, include the Port bounds, otherwise exclude

    Returns
    Type
    System.Drawing.RectangleF

    GetObjectData(SerializationInfo, StreamingContext)

    Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

    Declaration
    protected virtual void GetObjectData(SerializationInfo info, StreamingContext context)
    Parameters
    Type Name Description
    System.Runtime.Serialization.SerializationInfo info

    The System.Runtime.Serialization.SerializationInfo to populate with data.

    System.Runtime.Serialization.StreamingContext context

    The destination (see System.Runtime.Serialization.StreamingContext) for this serialization.

    Exceptions
    Type Condition
    System.Security.SecurityException

    The caller does not have the required permission.

    GetParentTransformation(Boolean)

    Gets the parent transformation.

    Declaration
    protected Matrix GetParentTransformation(bool bCurrentInclude)
    Parameters
    Type Name Description
    System.Boolean bCurrentInclude

    if set to true to include current node transformation.

    Returns
    Type Description
    System.Drawing.Drawing2D.Matrix

    The matrix

    GetPathBounds()

    Methods used to get node's GraphicsPath

    Declaration
    protected virtual RectangleF GetPathBounds()
    Returns
    Type Description
    System.Drawing.RectangleF

    node's GraphicsPath

    Remarks

    Used primarily for Group node to get all children paths union with transformations.

    GetPropertyContainer(String)

    Gets the property container.

    Declaration
    protected virtual object GetPropertyContainer(string strPropertyContainerName)
    Parameters
    Type Name Description
    System.String strPropertyContainerName

    Name of the property container.

    Returns
    Type Description
    System.Object

    The object.

    GetPropertyContainerByName(String)

    Gets the name of the property container by.

    Declaration
    public object GetPropertyContainerByName(string strPropertyContainerName)
    Parameters
    Type Name Description
    System.String strPropertyContainerName

    Name of the property container.

    Returns
    Type Description
    System.Object

    The object.

    GetRectBounds(Boolean, Boolean)

    Return the path bounds of the node

    Declaration
    protected virtual RectangleF GetRectBounds(bool excludeLabel, bool excludePort)
    Parameters
    Type Name Description
    System.Boolean excludeLabel

    if true, include the label bounds, otherwise exclude

    System.Boolean excludePort

    if true, include the Port bounds, otherwise exclude

    Returns
    Type
    System.Drawing.RectangleF

    GetScaleTransformation()

    Gets the node scale transformation.

    Declaration
    protected Matrix GetScaleTransformation()
    Returns
    Type Description
    System.Drawing.Drawing2D.Matrix

    The matrix

    GetService(Type)

    Gets the service object of the specified type.

    Declaration
    public virtual object GetService(Type serviceType)
    Parameters
    Type Name Description
    System.Type serviceType

    An object that specifies the type of service object to get.

    Returns
    Type Description
    System.Object

    A service object of type serviceType.-or- null if there is no service object of type serviceType.

    GetTransformations()

    Gets node's transformations.

    Declaration
    public Matrix GetTransformations()
    Returns
    Type Description
    System.Drawing.Drawing2D.Matrix

    The matrix.

    GetTransformations(PointF, SizeF, Single)

    Gets the transformations.

    Declaration
    protected Matrix GetTransformations(PointF ptPinPoint, SizeF szPinOffset, float fAngle)
    Parameters
    Type Name Description
    System.Drawing.PointF ptPinPoint

    The pin point.

    System.Drawing.SizeF szPinOffset

    The pin offset.

    System.Single fAngle

    The rotation angle.

    Returns
    Type Description
    System.Drawing.Drawing2D.Matrix

    The matrix

    GetUpperLeftPoint(MeasureUnits)

    Gets the upper left point in given units.

    Declaration
    protected PointF GetUpperLeftPoint(MeasureUnits unit)
    Parameters
    Type Name Description
    MeasureUnits unit

    The graphics unit.

    Returns
    Type Description
    System.Drawing.PointF

    The point.

    IsClosedPath(GraphicsPath)

    Determines whether specified shape is closed.

    Declaration
    protected bool IsClosedPath(GraphicsPath path)
    Parameters
    Type Name Description
    System.Drawing.Drawing2D.GraphicsPath path

    The path.

    Returns
    Type Description
    System.Boolean

    true if the specified shape is closed ; otherwise, false.

    LogicalUnitChange(GraphicsUnit)

    Logicals the unit change.

    Declaration
    protected virtual void LogicalUnitChange(GraphicsUnit unit)
    Parameters
    Type Name Description
    System.Drawing.GraphicsUnit unit

    The unit.

    Move(Single, Single)

    Moves the specified offset.

    Declaration
    protected void Move(float fX, float fY)
    Parameters
    Type Name Description
    System.Single fX

    The x offset.

    System.Single fY

    The y offset.

    OnDeserialized()

    Called when node is deserialized.

    Declaration
    protected virtual void OnDeserialized()

    OnMeasurementUnitsChanging(MeasureUnits)

    Called when measurement units value changing.

    Declaration
    protected virtual void OnMeasurementUnitsChanging(MeasureUnits unitsNew)
    Parameters
    Type Name Description
    MeasureUnits unitsNew

    The units new.

    OnMouseClick(EventArgs)

    Raises the mouse single click event.

    Declaration
    protected virtual void OnMouseClick(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    OnMouseDoubleClick(EventArgs)

    Raises the mouse double click event.

    Declaration
    protected virtual void OnMouseDoubleClick(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    OnMouseEnter(EventArgs)

    Raises the mouse enter event.

    Declaration
    protected virtual void OnMouseEnter(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    OnMouseLeave(EventArgs)

    Raises the mouse leave event.

    Declaration
    protected virtual void OnMouseLeave(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    OnNodeScaleChanged(String)

    Called when node scale factor is changed.

    Declaration
    protected virtual void OnNodeScaleChanged(string strPropertyName)
    Parameters
    Type Name Description
    System.String strPropertyName

    The property name that change scale factor value.

    OnParentChanged()

    Called when parent changed.

    Declaration
    protected virtual void OnParentChanged()

    OnParentChanging()

    Called when parent changing.

    Declaration
    protected virtual void OnParentChanging()

    OnPropertyChanged(String, String)

    Called when property changed.

    Declaration
    public virtual void OnPropertyChanged(string strPropertyContainerName, string strPropertyName)
    Parameters
    Type Name Description
    System.String strPropertyContainerName

    Name of the property container.

    System.String strPropertyName

    Name of the property.

    OnPropertyChanging(String, String, Object)

    Called when property changing.

    Declaration
    public virtual bool OnPropertyChanging(string strPropertyContainerName, string strPropertyName, object newValue)
    Parameters
    Type Name Description
    System.String strPropertyContainerName

    Name of the property container.

    System.String strPropertyName

    Name of the property.

    System.Object newValue

    The new value.

    Returns
    Type Description
    System.Boolean

    true, if property changing.

    PrepareGraphics(Graphics)

    Prepares the graphics to draw.

    Declaration
    protected virtual void PrepareGraphics(Graphics gfx)
    Parameters
    Type Name Description
    System.Drawing.Graphics gfx

    Graphics to draw on.

    ProvideServiceReference(RuntimeTypeHandle)

    Get the service reference from provider.

    Declaration
    public virtual object ProvideServiceReference(RuntimeTypeHandle typeHandle)
    Parameters
    Type Name Description
    System.RuntimeTypeHandle typeHandle

    The type handle.

    Returns
    Type Description
    System.Object

    The object.

    QuiteBoundarySet(Boolean)

    Quites set boundary value without record in history and calling sink events.

    Declaration
    protected void QuiteBoundarySet(bool bBoundaryConstraintsEnabled)
    Parameters
    Type Name Description
    System.Boolean bBoundaryConstraintsEnabled

    if set to true boundary constraints enabled.

    RecordPropertyChanged(String)

    Updates the ports connections.

    Declaration
    protected void RecordPropertyChanged(string strPropertyName)
    Parameters
    Type Name Description
    System.String strPropertyName

    Property name.

    Render(Graphics)

    Renders shapes visual representation on given graphics.

    Declaration
    protected virtual void Render(Graphics gfx)
    Parameters
    Type Name Description
    System.Drawing.Graphics gfx

    Graphics to draw on

    RenderContiguousData(Graphics)

    methods used to draw contiguous date. Such as labels or ports

    Declaration
    protected virtual void RenderContiguousData(Graphics gfx)
    Parameters
    Type Name Description
    System.Drawing.Graphics gfx

    Graphics to draw on

    Rotate(Single)

    Rotates the shape a specified number of degrees about its center point.

    Declaration
    public void Rotate(float degrees)
    Parameters
    Type Name Description
    System.Single degrees

    Number of degrees to rotate.

    SafeHistoryPause()

    Safe pause history recording.

    Declaration
    protected void SafeHistoryPause()

    SafeHistoryResume()

    Safe restore history recording.

    Declaration
    protected void SafeHistoryResume()

    Scale(Single, Single)

    Scales the shape about its center point by a given ratio.

    Declaration
    public void Scale(float fScaleFactorX, float fScaleFactorY)
    Parameters
    Type Name Description
    System.Single fScaleFactorX

    Scaling ratio for X axis.

    System.Single fScaleFactorY

    Scaling ratio for Y axis.

    SetPinOffset(SizeF, SizeF)

    Sets the pin offset.

    Declaration
    protected void SetPinOffset(SizeF szOldPinOffset, SizeF szNewPinOffset)
    Parameters
    Type Name Description
    System.Drawing.SizeF szOldPinOffset

    The old pin offset.

    System.Drawing.SizeF szNewPinOffset

    The new pin offset.

    SetPinPoint(PointF, MeasureUnits)

    Set the pin point position.

    Declaration
    protected virtual void SetPinPoint(PointF ptValue, MeasureUnits unit)
    Parameters
    Type Name Description
    System.Drawing.PointF ptValue

    The pin position.

    MeasureUnits unit

    The measure unit.

    SetSize(SizeF, SizeF)

    Used to update child nodes sizes.

    Declaration
    protected void SetSize(SizeF szOldSize, SizeF szNewSize)
    Parameters
    Type Name Description
    System.Drawing.SizeF szOldSize

    Old size.

    System.Drawing.SizeF szNewSize

    New size.

    ShowResizeHandles()

    Indicate that selection and resize handles will draw on diagram canvas.

    Declaration
    public virtual bool ShowResizeHandles()
    Returns
    Type Description
    System.Boolean

    true, if show resize handles.

    Translate(Single, Single)

    Moves the shape by the given X and Y offsets.

    Declaration
    public void Translate(float fX, float fY)
    Parameters
    Type Name Description
    System.Single fX

    Distance to move along X axis.

    System.Single fY

    Distance to move along Y axis.

    Translate(Single, Single, MeasureUnits)

    Moves the shape by the given X and Y offsets.

    Declaration
    public void Translate(float fX, float fY, MeasureUnits measureUnits)
    Parameters
    Type Name Description
    System.Single fX

    Distance to move along X axis.

    System.Single fY

    Distance to move along Y axis.

    MeasureUnits measureUnits

    Specifies translate offsets measure units.

    UpdateBoundingRectangle()

    Updates the bounding rectangle.

    Declaration
    protected virtual void UpdateBoundingRectangle()

    UpdateContainerBounds()

    Updates the container bounds.

    Declaration
    protected void UpdateContainerBounds()

    UpdateGraphicsPath(SizeF, SizeF)

    Updates the graphics path and region.

    Declaration
    protected virtual void UpdateGraphicsPath(SizeF szOldSize, SizeF szNewSize)
    Parameters
    Type Name Description
    System.Drawing.SizeF szOldSize

    Old size value.

    System.Drawing.SizeF szNewSize

    New size value.

    UpdateHelperRegion()

    Creates region used for hit testing.

    Declaration
    protected virtual void UpdateHelperRegion()

    UpdatePortPositions(SizeF, SizeF)

    Update port positions on change node size.

    Declaration
    protected void UpdatePortPositions(SizeF szOldSize, SizeF szNewSize)
    Parameters
    Type Name Description
    System.Drawing.SizeF szOldSize

    Old size.

    System.Drawing.SizeF szNewSize

    New size.

    UpdateReferences(IServiceReferenceProvider)

    Updates the references.

    Declaration
    public virtual void UpdateReferences(IServiceReferenceProvider provider)
    Parameters
    Type Name Description
    IServiceReferenceProvider provider

    The provider.

    UpdateRefreshRect()

    Updates node's refresh rect

    Declaration
    protected virtual void UpdateRefreshRect()
    Remarks

    Includes all contiguous data like ports, labels etc.

    UpdateRefreshRect(RectangleF, Matrix)

    Updates node's refresh rect used node graphics path bounds.

    Declaration
    protected void UpdateRefreshRect(RectangleF rcPathBounds, Matrix mtxNodeTransformation)
    Parameters
    Type Name Description
    System.Drawing.RectangleF rcPathBounds

    The node path bounds.

    System.Drawing.Drawing2D.Matrix mtxNodeTransformation

    Node matrix transformations.

    UpdateServiceReferences(IServiceReferenceProvider)

    Updates the service references.

    Declaration
    public void UpdateServiceReferences(IServiceReferenceProvider provider)
    Parameters
    Type Name Description
    IServiceReferenceProvider provider

    The provider.

    Explicit Interface Implementations

    IDispatchNodeEvents.Click(EventArgs)

    Declaration
    void IDispatchNodeEvents.Click(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    IDispatchNodeEvents.DoubleClick(EventArgs)

    Declaration
    void IDispatchNodeEvents.DoubleClick(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    IDispatchNodeEvents.MouseEnter(EventArgs)

    Declaration
    void IDispatchNodeEvents.MouseEnter(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    IDispatchNodeEvents.MouseLeave(EventArgs)

    Declaration
    void IDispatchNodeEvents.MouseLeave(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    INode.Root

    Declaration
    INode INode.Root { get; }
    Returns
    Type
    INode

    IUnitIndependent.GetBoundingRectangle(MeasureUnits, Boolean)

    Gets the bounding rectangle.

    Declaration
    RectangleF IUnitIndependent.GetBoundingRectangle(MeasureUnits unit, bool bRelativeToModel)
    Parameters
    Type Name Description
    MeasureUnits unit

    The unit.

    System.Boolean bRelativeToModel

    if set to true to get bounds in model coordinates, otherwise - false.

    Returns
    Type Description
    System.Drawing.RectangleF

    The System.Drawing.RectangleF.

    IUnitIndependent.GetPinPoint(MeasureUnits)

    Gets the pin point.

    Declaration
    PointF IUnitIndependent.GetPinPoint(MeasureUnits unit)
    Parameters
    Type Name Description
    MeasureUnits unit

    The unit.

    Returns
    Type Description
    System.Drawing.PointF

    The pin point.

    IUnitIndependent.GetPinPointOffset(MeasureUnits)

    Gets the pin point offset.

    Declaration
    SizeF IUnitIndependent.GetPinPointOffset(MeasureUnits unit)
    Parameters
    Type Name Description
    MeasureUnits unit

    The unit.

    Returns
    Type Description
    System.Drawing.SizeF

    The pin point offset/

    IUnitIndependent.GetSize(MeasureUnits)

    Gets the size.

    Declaration
    SizeF IUnitIndependent.GetSize(MeasureUnits unit)
    Parameters
    Type Name Description
    MeasureUnits unit

    The unit.

    Returns
    Type Description
    System.Drawing.SizeF

    The size.

    IUnitIndependent.SetPinPoint(PointF, MeasureUnits)

    Set the pin point.

    Declaration
    void IUnitIndependent.SetPinPoint(PointF ptValue, MeasureUnits unit)
    Parameters
    Type Name Description
    System.Drawing.PointF ptValue

    The location value.

    MeasureUnits unit

    The unit.

    IUnitIndependent.SetPinPointOffset(SizeF, MeasureUnits)

    Set the pin point offset.

    Declaration
    void IUnitIndependent.SetPinPointOffset(SizeF szValue, MeasureUnits unit)
    Parameters
    Type Name Description
    System.Drawing.SizeF szValue

    The new offset size value.

    MeasureUnits unit

    The unit.

    IUnitIndependent.SetSize(SizeF, MeasureUnits)

    Set the size.

    Declaration
    void IUnitIndependent.SetSize(SizeF szValue, MeasureUnits unit)
    Parameters
    Type Name Description
    System.Drawing.SizeF szValue

    The new size value.

    MeasureUnits unit

    The unit.

    IDeserializationCallback.OnDeserialization(Object)

    Runs when the entire object graph has been deserialized.

    Declaration
    void IDeserializationCallback.OnDeserialization(object sender)
    Parameters
    Type Name Description
    System.Object sender

    The object that initiated the callback. The functionality for this parameter is not currently implemented.

    ISerializable.GetObjectData(SerializationInfo, StreamingContext)

    Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

    Declaration
    void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context)
    Parameters
    Type Name Description
    System.Runtime.Serialization.SerializationInfo info

    The System.Runtime.Serialization.SerializationInfo to populate with data.

    System.Runtime.Serialization.StreamingContext context

    The destination (see System.Runtime.Serialization.StreamingContext) for this serialization.

    Exceptions
    Type Condition
    System.Security.SecurityException

    The caller does not have the required permission.

    Implements

    IUnitIndependent
    IDispatchNodeEvents
    System.Runtime.Serialization.ISerializable
    INode
    System.ICloneable
    IServiceReferenceHolder
    IServiceReferenceProvider
    IPropertyObserver
    IPropertyContainer
    System.IServiceProvider
    IGraphNode
    System.Runtime.Serialization.IDeserializationCallback
    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved