Class HandlesHitTesting

Helper class that contains methods to check hit testing and append node transformations.

Inheritance

System.Object

HandlesHitTesting

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.Windows.Forms.Diagram

Assembly: Syncfusion.Diagram.Base.dll

Syntax

public class HandlesHitTesting

Constructors

HandlesHitTesting()

Declaration

public HandlesHitTesting()

Properties

NameIndex

Gets the regex instance to split node name and index.

Declaration

public static Regex NameIndex { get; }

Property Value

Type	Description
System.Text.RegularExpressions.Regex	The regex instance.

ScaleFactor

Gets or sets the scale factor for handles hit testing.

Declaration

public static float ScaleFactor { get; set; }

Property Value

Type	Description
System.Single	The scale factor.

Remarks

This properties used for checking hit testing on handles with given scale factor. Needed to set before every handle getting.

TouchMode

Gets or sets the value indicating that whether the touch mode is enabled or not.

Declaration

public static bool TouchMode { get; set; }

Property Value

Type	Description
System.Boolean

Methods

AppendParentsFlipTransformations(Matrix, Node)

Appends the parents flip transformations.

Declaration

public static void AppendParentsFlipTransformations(Matrix mtxMatrix, Node node)

Parameters

Type	Name	Description
System.Drawing.Drawing2D.Matrix	mtxMatrix	The matrix to append.
Node	node	The node.

AppendScaleTransforms(Node, Matrix, Boolean)

Append the node scale transformation.

Declaration

public static void AppendScaleTransforms(Node node, Matrix mtxTemp, bool bSkipGivenNode)

Parameters

Type	Name	Description
Node	node	The node.
System.Drawing.Drawing2D.Matrix	mtxTemp	The MTX temp.
System.Boolean	bSkipGivenNode	if set to true [b skip given node].

CanResizeChildren(ICompositeNode)

Determines whether composite node can resize children in one dimension.

Declaration

public static bool CanResizeChildren(ICompositeNode compositeNode)

Parameters

Type	Name	Description
ICompositeNode	compositeNode	The composite node to check.

Returns

Type	Description
System.Boolean	true if given composite can resize children in one dimension; otherwise, false.

CanSelectNode(Node)

Check if node can select.

Declaration

public static bool CanSelectNode(Node node)

Parameters

Type	Name	Description
Node	node	Node to check.

Returns

Type	Description
System.Boolean	True if node can be selected, otherwise - false.

ConvertToModelCoordinates(Node, Node)

Convert from parent node to model coordinates.

Declaration

public static void ConvertToModelCoordinates(Node node, Node parent)

Parameters

Type	Name	Description
Node	node	The node to convert.
Node	parent	The node parent.

ConvertToParentCoordinates(Node, Node)

Convert nodes from model to parent node coordinates.

Declaration

public static void ConvertToParentCoordinates(Node node, Node parent)

Parameters

Type	Name	Description
Node	node	The node to covert.
Node	parent	The node parent.

GenerateUniqueNodeName(Hashtable, Node, out String, Regex)

Called to generate a unique name when inserting a new node.

Declaration

public static bool GenerateUniqueNodeName(Hashtable nameTable, Node obj, out string nodeName, Regex regex)

Parameters

Type	Name	Description
System.Collections.Hashtable	nameTable	The name table hash where key - node name, value list of indexes.
Node	obj	Node to generate unique name for.
System.String	nodeName	Node name generated.
System.Text.RegularExpressions.Regex	regex	Regex used to split node name.

Returns

Type	Description
System.Boolean	True if a new name was generated; False if the name is already unique.

Remarks

The implementation of this method first checks to see if the name is already unique. If it is, then it returns False to the caller and the nodeName parameter contains the original name. If the node's name is not unique within the model, then this method adds a numeric suffix to the name and continues to increment it in a loop until the name is unique. If the nodeName output parameter contains a value other than the original node name, then this method returns True.

This method can be overriden in derived classes in order to customize or replace the algorithm for generating unique names.

GetAllNodesAtPoint(ICompositeNode, PointF, Boolean, Boolean)

Get all nodes at given point.

Declaration

public static NodeCollection GetAllNodesAtPoint(ICompositeNode compositeNode, PointF ptPoint, bool bOnlyCanSelected, bool bGroupFirst)

Parameters

Type	Name	Description
ICompositeNode	compositeNode	The parent.
System.Drawing.PointF	ptPoint	The point to check .
System.Boolean	bOnlyCanSelected	if set to true result collection contain only nodes what can be selected.
System.Boolean	bGroupFirst	if set to true group will add before it children.

Returns

Type	Description
NodeCollection	The node collection.

GetConnectionPointAtPoint(Node, Matrix, PointF)

Returns ConnectionPoint that belongs to the node transformed using the given transformation matrix and intersects with point.

Declaration

public static ConnectionPoint GetConnectionPointAtPoint(Node node, Matrix matrixParent, PointF ptTesting)

Parameters

Type	Name	Description
Node	node	Ports container.
System.Drawing.Drawing2D.Matrix	matrixParent	Parent's transformation matrix.
System.Drawing.PointF	ptTesting	Search point of the port.

Returns

Type	Description
ConnectionPoint	Connection point.

GetConnectionPointAtPoint(Node, Point)

Returns ConnectionPoint, that belongs to the node transformed using given transformation matrix and intersects with point.

Declaration

public static ConnectionPoint GetConnectionPointAtPoint(Node node, Point ptTesting)

Parameters

Type	Name	Description
Node	node	Node for port search.
System.Drawing.Point	ptTesting	Point that contains port.

Returns

Type	Description
ConnectionPoint	Connection point.

GetConnectionPointAtPoint(Node, PointF)

Returns ConnectionPoint, that belongs to the node transformed using given transformation matrix and intersects with point.

Declaration

public static ConnectionPoint GetConnectionPointAtPoint(Node node, PointF ptTesting)

Parameters

Type	Name	Description
Node	node	Node for port search.
System.Drawing.PointF	ptTesting	Point that contains port.

Returns

Type	Description
ConnectionPoint	Connection point.

GetConnectionPointAtPoint(NodeCollection, Point)

Returns ConnectionPoint, that belongs to the node transformed using given transformation matrix and intersects with point.

Declaration

public static ConnectionPoint GetConnectionPointAtPoint(NodeCollection nodes, Point ptTesting)

Parameters

Type	Name	Description
NodeCollection	nodes	Nodes collection for port search.
System.Drawing.Point	ptTesting	Point that contains port.

Returns

Type	Description
ConnectionPoint	Connection point.

GetConnectionPointAtPoint(NodeCollection, PointF)

Returns ConnectionPoint, that belongs to the node transformed using given transformation matrix and intersects with point.

Declaration

public static ConnectionPoint GetConnectionPointAtPoint(NodeCollection nodes, PointF ptTesting)

Parameters

Type	Name	Description
NodeCollection	nodes	Nodes collection for port search.
System.Drawing.PointF	ptTesting	Point that contains port.

Returns

Type	Description
ConnectionPoint	The connection point.

GetControlPointAtPoint(NodeCollection, Point, ref IHandle)

Returns topmost node and its handle that is in search point.

Declaration

public static PathNode GetControlPointAtPoint(NodeCollection nodes, Point ptTesting, ref IHandle handleHit)

Parameters

Type	Name	Description
NodeCollection	nodes	Nodes collection for handle search.
System.Drawing.Point	ptTesting	Handle search point.
IHandle	handleHit	Node handle that is in search point.

Returns

Type	Description
PathNode	The node at the specified point.

GetControlPointAtPoint(NodeCollection, PointF, ref IHandle)

Returns topmost node and its handle that is in search point.

Declaration

public static PathNode GetControlPointAtPoint(NodeCollection nodes, PointF ptTesting, ref IHandle handleHit)

Parameters

Type	Name	Description
NodeCollection	nodes	Nodes collection for handle search.
System.Drawing.PointF	ptTesting	Handle search point.
IHandle	handleHit	Node handle that is in search point.

Returns

Type	Description
PathNode	The node at the specified point.

GetEndPointAtPoint(IEndPointContainer, Point, ref IHandle)

Returns topmost container and EndPoint that is found in ptTesting point.

Declaration

public static bool GetEndPointAtPoint(IEndPointContainer node, Point ptTesting, ref IHandle handleHit)

Parameters

Type	Name	Description
IEndPointContainer	node	Possibly EndPoint container.
System.Drawing.Point	ptTesting	Search point of the EndPoint from nodes collection.
IHandle	handleHit	Container EndPoint that is found in search point.

Returns

Type	Description
System.Boolean	true, if get end point.

GetEndPointAtPoint(IEndPointContainer, PointF, ref IHandle)

Returns topmost container and EndPoint that is found in ptTesting point.

Declaration

public static bool GetEndPointAtPoint(IEndPointContainer node, PointF ptTesting, ref IHandle handleHit)

Parameters

Type	Name	Description
IEndPointContainer	node	Possibly the EndPoint container.
System.Drawing.PointF	ptTesting	Search point of the EndPoint from nodes collection.
IHandle	handleHit	Container EndPoint that is found in search point.

Returns

Type	Description
System.Boolean	true, if get end point.

GetEndPointAtPoint(NodeCollection, Point, ref IHandle)

Returns topmost container and EndPoint that is found in ptTesting point.

Declaration

public static Node GetEndPointAtPoint(NodeCollection nodes, Point ptTesting, ref IHandle handleHit)

Parameters

Type	Name	Description
NodeCollection	nodes	Collection for search of the EndPoint container.
System.Drawing.Point	ptTesting	Search point of the EndPoint from nodes collection.
IHandle	handleHit	Container EndPoint that is found in search point.

Returns

Type	Description
Node	The node at the specified point.

GetEndPointAtPoint(NodeCollection, PointF, ref IHandle)

Shows whether PinPoint can be found in the ptTesting point.

Declaration

public static Node GetEndPointAtPoint(NodeCollection nodes, PointF ptTesting, ref IHandle handleHit)

Parameters

Type	Name	Description
NodeCollection	nodes	Collection for PinPoint verification.
System.Drawing.PointF	ptTesting	Point for PinPoint search.
IHandle	handleHit	The handle hit.

Returns

Type	Description
Node	The node at the specified point.

GetEndPointLocation(ConnectionPoint, EndPoint)

Get docked the end point location to port location.

Declaration

public static PointF GetEndPointLocation(ConnectionPoint port, EndPoint endPoint)

Parameters

Type	Name	Description
ConnectionPoint	port	The port.
EndPoint	endPoint	The end point.

Returns

Type	Description
System.Drawing.PointF	The endpoint.

GetNodeParentTransformations(Node)

Gets the node transformations with all parent hierarchy transformations.

Declaration

public static Matrix GetNodeParentTransformations(Node node)

Parameters

Type	Name	Description
Node	node	The node.

Returns

Type	Description
System.Drawing.Drawing2D.Matrix	returns the Parent transformation Matrix value.

GetNodesContainedBy(NodeCollection, RectangleF)

Returns nodes from collection given, which are located inside rectangle recbBounding.

Declaration

public static NodeCollection GetNodesContainedBy(NodeCollection nodes, RectangleF recbBounding)

Parameters

Type	Name	Description
NodeCollection	nodes	Collection for verification.
System.Drawing.RectangleF	recbBounding	Rectangle in which nodes are located..

Returns

Type	Description
NodeCollection	Contained node collection.

GetNodesIntersecting(NodeCollection, RectangleF)

Returns nodes from collection given, which intersects with rectangle recbBounding.

Declaration

public static NodeCollection GetNodesIntersecting(NodeCollection nodes, RectangleF recbBounding)

Parameters

Type	Name	Description
NodeCollection	nodes	Collection for verification.
System.Drawing.RectangleF	recbBounding	Rectangle in which nodes are located..

Returns

Type	Description
NodeCollection	Node collection.

GetParentsFlipX(Node)

Indicates whether FlipX is enabled for parent of the given Node.

Declaration

public static bool GetParentsFlipX(Node node)

Parameters

Type	Name	Description
Node	node	The node.

Returns

Type	Description
System.Boolean	Returns true, if the parents of the given node's FlipX is enabled

GetParentsFlipX(Node, Boolean)

Indicates whether FlipX is enabled for parent of the given Node.

Declaration

public static bool GetParentsFlipX(Node node, bool bGivenInclude)

Parameters

Type	Name	Description
Node	node	The node.
System.Boolean	bGivenInclude	if set to true given node will include to result.

Returns

Type	Description
System.Boolean	Returns true, if the parent of the given node's FlipX is enabled

GetParentsFlipY(Node)

Indicates whether FlipY is enabled for parent of the given Node.

Declaration

public static bool GetParentsFlipY(Node node)

Parameters

Type	Name	Description
Node	node	The node.

Returns

Type	Description
System.Boolean	Returns true, if the parents of the given node's FlipY is enabled

GetParentsFlipY(Node, Boolean)

Indicates whether FlipX is enabled for parent of the given Node.

Declaration

public static bool GetParentsFlipY(Node node, bool bGivenInclude)

Parameters

Type	Name	Description
Node	node	The node.
System.Boolean	bGivenInclude	if set to true given node will include to result.

Returns

Type	Description
System.Boolean	Returns true, if the parent of the given node's FlipX is enabled

GetParentsLocalTransformations(Node)

Gets the parents rotation.

Declaration

public static Matrix GetParentsLocalTransformations(Node node)

Parameters

Type	Name	Description
Node	node	The node.

Returns

Type	Description
System.Drawing.Drawing2D.Matrix	returns the Parents local transformation Matrix value.

GetParentsRotation(Node)

Gets the parents rotation.

Declaration

public static float GetParentsRotation(Node node)

Parameters

Type	Name	Description
Node	node	The node.

Returns

Type	Description
System.Single	The parents rotation value.

GetParentsRotationTransform(Node)

Gets the parents rotation transform.

Declaration

public static Matrix GetParentsRotationTransform(Node node)

Parameters

Type	Name	Description
Node	node	The node.

Returns

Type	Description
System.Drawing.Drawing2D.Matrix	The matrix.

GetParentsTransformations(Node)

Gets the parents rotation.

Declaration

public static Matrix GetParentsTransformations(Node node)

Parameters

Type	Name	Description
Node	node	The node.

Returns

Type	Description
System.Drawing.Drawing2D.Matrix	returns the Parent transformation Matrix value.

GetParentsTransformations(Node, Boolean)

Returns matrix which is an accumulated transformations from parents according to hierarchy, if bWithGivenNode parameter is set to true, node's own matrix will also be included).

Declaration

public static Matrix GetParentsTransformations(Node node, bool bWithGivenNode)

Parameters

Type	Name	Description
Node	node	Node for verification
System.Boolean	bWithGivenNode	if bWithGivenNode parameter is set to true, node's own matrix will also be included.

Returns

Type	Description
System.Drawing.Drawing2D.Matrix	returns the Parents transformation Matrix value.

GetPinPointAtPoint(Node, Point)

Shows whether PinPoint can be found in the ptTesting point.

Declaration

public static bool GetPinPointAtPoint(Node node, Point ptTesting)

Parameters

Type	Name	Description
Node	node	Node for PinPoint verification.
System.Drawing.Point	ptTesting	Point for PinPoint search.

Returns

Type	Description
System.Boolean	true, if get pin point.

GetPinPointAtPoint(Node, PointF)

Returns topmost node from collection, PinPoint of which, is in ptTesting point.

Declaration

public static bool GetPinPointAtPoint(Node node, PointF ptTesting)

Parameters

Type	Name	Description
Node	node	PinPoint container.
System.Drawing.PointF	ptTesting	Point of the possible location of the Pinpoint.

Returns

Type	Description
System.Boolean	true, if get pin point.

GetPinPointAtPoint(NodeCollection, Point)

Returns topmost node from collection, PinPoint of which, is in ptTesting point.

Declaration

public static Node GetPinPointAtPoint(NodeCollection nodes, Point ptTesting)

Parameters

Type	Name	Description
NodeCollection	nodes	Collection for PinPoint search.
System.Drawing.Point	ptTesting	Point of the possible location of the Pinpoint.

Returns

Type	Description
Node	The node at the specified point.

GetPinPointAtPoint(NodeCollection, PointF)

Returns topmost node from collection, PinPoint of which, is in ptTesting point.

Declaration

public static Node GetPinPointAtPoint(NodeCollection nodes, PointF ptTesting)

Parameters

Type	Name	Description
NodeCollection	nodes	Collection for PinPoint search.
System.Drawing.PointF	ptTesting	Point of the possible location of the Pinpoint.

Returns

Type	Description
Node	The node at the specified point.

GetPortPosition(ConnectionPoint)

Gets the port position with parent transformations.

Declaration

public static PointF GetPortPosition(ConnectionPoint port)

Parameters

Type	Name	Description
ConnectionPoint	port	The port.

Returns

Type	Description
System.Drawing.PointF	The port position.

GetRefreshRectangle(Node)

Gets the node graphics path refresh rectangle include shadow, line width, decorators, labels and ports.

Declaration

public static RectangleF GetRefreshRectangle(Node node)

Parameters

Type	Name	Description
Node	node	The node.

Returns

Type	Description
System.Drawing.RectangleF	The refresh rect.

GetResizeHandleAtPoint(Node, Point, ref BoxPosition)

Returns node and ResizeHandle position that is found in ptTesting point from nodes collection.

Declaration

public static bool GetResizeHandleAtPoint(Node node, Point ptTesting, ref BoxPosition handleHit)

Parameters

Type	Name	Description
Node	node	The node.
System.Drawing.Point	ptTesting	Search point of ResizeHandle.
BoxPosition	handleHit	Handle position in ptTesting point.

Returns

Type	Description
System.Boolean	true, if get the resize handle.

GetResizeHandleAtPoint(Node, PointF, ref BoxPosition)

Shows whether there is at least one handle in the ptTesting point that belongs to the node.

Declaration

public static bool GetResizeHandleAtPoint(Node node, PointF ptTesting, ref BoxPosition handleHit)

Parameters

Type	Name	Description
Node	node	Handles owner for verification.
System.Drawing.PointF	ptTesting	Point of possible location of the ResizeHandle.
BoxPosition	handleHit	Handle position in ptTesting point.

Returns

Type	Description
System.Boolean	true, if get the resize handle.

GetResizeHandleAtPoint(NodeCollection, Point, ref BoxPosition)

Returns node and ResizeHandle position that is found in ptTesting point from nodes collection.

Declaration

public static Node GetResizeHandleAtPoint(NodeCollection nodes, Point ptTesting, ref BoxPosition handleHit)

Parameters

Type	Name	Description
NodeCollection	nodes	Collection for verification.
System.Drawing.Point	ptTesting	Search point of ResizeHandle.
BoxPosition	handleHit	Handle position in ptTesting point.

Returns

Type	Description
Node	The resize handle at the specified point.

GetResizeHandleAtPoint(NodeCollection, PointF, ref BoxPosition)

Returns node and ResizeHandle position that is found in ptTesting point from nodes collection.

Declaration

public static Node GetResizeHandleAtPoint(NodeCollection nodes, PointF ptTesting, ref BoxPosition handleHit)

Parameters

Type	Name	Description
NodeCollection	nodes	Collection for verification.
System.Drawing.PointF	ptTesting	Search point of ResizeHandle.
BoxPosition	handleHit	Handle position in ptTesting point.

Returns

Type	Description
Node	The node and resize handle position at the given point.

GetRotationHandleAtPoint(Node, Point)

Shows whether there is at least one RotationHandle in the ptTesting point that belongs to node.

Declaration

public static Node GetRotationHandleAtPoint(Node node, Point ptTesting)

Parameters

Type	Name	Description
Node	node	Handle owner for verification.
System.Drawing.Point	ptTesting	Point of possible location of the RotationHandle.

Returns

Type	Description
Node	The node at the specified point.

GetRotationHandleAtPoint(Node, PointF)

Shows whether there is at least one RotationHandle in the ptTesting point that belongs to node.

Declaration

public static Node GetRotationHandleAtPoint(Node node, PointF ptTesting)

Parameters

Type	Name	Description
Node	node	Handle owner for verification.
System.Drawing.PointF	ptTesting	Point of possible location of the RotationHandle.

Returns

Type	Description
Node	The node at the specified point.

GetRotationHandleAtPoint(NodeCollection, Point)

Returns node and RotationHandle position that is located in ptTesting point from nodes collection.

Declaration

public static Node GetRotationHandleAtPoint(NodeCollection nodes, Point ptTesting)

Parameters

Type	Name	Description
NodeCollection	nodes	Collection for verification.
System.Drawing.Point	ptTesting	Search point for RotationHandle.

Returns

Type	Description
Node	true, if get the rotation handle.

GetRotationHandleAtPoint(NodeCollection, PointF)

Returns node and RotationHandle position that is located in ptTesting point from nodes collection.

Declaration

public static Node GetRotationHandleAtPoint(NodeCollection nodes, PointF ptTesting)

Parameters

Type	Name	Description
NodeCollection	nodes	Collection for verification.
System.Drawing.PointF	ptTesting	Search point for RotationHandle.

Returns

Type	Description
Node	The rotation handle at the specified point.

GetSegmentLineAtPoint(Node, Point, ref Int32)

Returns topmost node and segment index in it, that contains/intersects with ptTesting point.

Declaration

public static bool GetSegmentLineAtPoint(Node node, Point ptTesting, ref int nSegmentID)

Parameters

Type	Name	Description
Node	node	Node for verification.
System.Drawing.Point	ptTesting	Search point of the segment.
System.Int32	nSegmentID	Index of segment that contains / intersects with ptTesting point.

Returns

Type	Description
System.Boolean	node to which the segment belongs.

GetSegmentLineAtPoint(Node, PointF, ref Int32)

Returns topmost node and segment index in it, that contains/intersects with ptTesting point.

Declaration

public static bool GetSegmentLineAtPoint(Node node, PointF ptTesting, ref int nSegmentID)

Parameters

Type	Name	Description
Node	node	Node for verification.
System.Drawing.PointF	ptTesting	Search point of the segment.
System.Int32	nSegmentID	Index of segment that contains / intersects with ptTesting point.

Returns

Type	Description
System.Boolean	node to which the segment belongs.

GetSegmentLineAtPoint(NodeCollection, Point, ref Int32)

Returns topmost node and segment index in it, that contains/intersects with ptTesting point.

Declaration

public static PathNode GetSegmentLineAtPoint(NodeCollection nodes, Point ptTesting, ref int nSegmentID)

Parameters

Type	Name	Description
NodeCollection	nodes	Nodes collection for verification.
System.Drawing.Point	ptTesting	Search point of the segment.
System.Int32	nSegmentID	Index of segment that contains / intersects with ptTesting point.

Returns

Type	Description
PathNode	node to which the segment belongs.

GetSegmentLineAtPoint(NodeCollection, PointF, ref Int32)

Returns topmost node and segment index in it, that contains/intersects with ptTesting point.

Declaration

public static PathNode GetSegmentLineAtPoint(NodeCollection nodes, PointF ptTesting, ref int nSegmentID)

Parameters

Type	Name	Description
NodeCollection	nodes	Nodes collection for verification.
System.Drawing.PointF	ptTesting	Search point of the segment.
System.Int32	nSegmentID	Index of segment that contains / intersects with ptTesting point.

Returns

Type	Description
PathNode	node to which the segment belongs.

GetSkippedIndexes(Int64[], Int64)

Gets the skipped indexes in indexes array.

Declaration

public static long[] GetSkippedIndexes(long[] indexes, long nNewIdxLength)

Parameters

Type	Name	Description
System.Int64[]	indexes	The indexes array.
System.Int64	nNewIdxLength	Length of the new index.

Returns

Type	Description
System.Int64[]	Array with skipped indexes.>

GetSumEditStyle(Node, ref EditStyle)

Gets the union of children edit styles.

Declaration

public static void GetSumEditStyle(Node node, ref EditStyle editStyle)

Parameters

Type	Name	Description
Node	node	The node.
EditStyle	editStyle	The edit style.

GetUpperLeftPoint(IUnitIndependent, MeasureUnits)

Gets the upper left point of node by pin position and pint offset.

Declaration

public static PointF GetUpperLeftPoint(IUnitIndependent node, MeasureUnits units)

Parameters

Type	Name	Description
IUnitIndependent	node	The node.
MeasureUnits	units	The units.

Returns

Type	Description
System.Drawing.PointF	Returns the Upper Left Point value

GetUpperLeftPoint(Node, MeasureUnits)

Gets the upper left point of node by pin position and pint offset.

Declaration

public static PointF GetUpperLeftPoint(Node node, MeasureUnits units)

Parameters

Type	Name	Description
Node	node	The node.
MeasureUnits	units	The units.

Returns

Type	Description
System.Drawing.PointF	Returns the Upper Left Point value

GetVertexHandleAtPoint(Node, Point, ref Int32)

Shows whether there is at least one vertex containing / intersecting with ptTesting point.

Declaration

public static bool GetVertexHandleAtPoint(Node node, Point ptTesting, ref int nVertexID)

Parameters

Type	Name	Description
Node	node	Vertex container.
System.Drawing.Point	ptTesting	Search point of the vertex.
System.Int32	nVertexID	Index of vertex that contains / intersects with ptTesting point.

Returns

Type	Description
System.Boolean	true, if get vertex handle.

GetVertexHandleAtPoint(Node, PointF, ref Int32)

Shows whether there is at least one vertex containing / intersecting with ptTesting point.

Declaration

public static bool GetVertexHandleAtPoint(Node node, PointF ptTesting, ref int nVertexID)

Parameters

Type	Name	Description
Node	node	Vertex container.
System.Drawing.PointF	ptTesting	Search point of the vertex.
System.Int32	nVertexID	Index of vertex that contains / intersects with ptTesting point.

Returns

Type	Description
System.Boolean	The vertex handle.

GetVertexHandleAtPoint(NodeCollection, Point, ref Int32)

Returns topmost node from the nodes collection and index of vertex, that contains/intersects with the testing point.

Declaration

public static PathNode GetVertexHandleAtPoint(NodeCollection nodes, Point ptTesting, ref int nVertexID)

Parameters

Type	Name	Description
NodeCollection	nodes	Nodes collection for verification.
System.Drawing.Point	ptTesting	Search point of the vertex.
System.Int32	nVertexID	Index of vertex that contains/intersects with ptTesting point.

Returns

Type	Description
PathNode	The path node.

GetVertexHandleAtPoint(NodeCollection, PointF, ref Int32)

Returns topmost node from the nodes collection and index of vertex, that contains/intersects with the testing point.

Declaration

public static PathNode GetVertexHandleAtPoint(NodeCollection nodes, PointF ptTesting, ref int nVertexID)

Parameters

Type	Name	Description
NodeCollection	nodes	Nodes collection for verification.
System.Drawing.PointF	ptTesting	Search point of the vertex.
System.Int32	nVertexID	Index of vertex that contains/intersects with ptTesting point.

Returns

Type	Description
PathNode	The path node.

IsParent(Node, Node)

Determines whether the specified given parent node is a child parent.

Declaration

public static bool IsParent(Node child, Node parent)

Parameters

Type	Name	Description
Node	child	The child node.
Node	parent	The parent node.

Returns

Type	Description
System.Boolean	true if the specified parent is a child parent; otherwise, false.

IsVisible(Node)

Check if node visible in diagram.

Declaration

public static bool IsVisible(Node node)

Parameters

Type	Name	Description
Node	node	Node to check.

Returns

Type	Description
System.Boolean	True if node is visible, otherwise - false.

RegisterNode(Hashtable, Node, Regex)

Register the name of the node to name table.

Declaration

public static void RegisterNode(Hashtable nameTable, Node node, Regex regex)

Parameters

Type	Name	Description
System.Collections.Hashtable	nameTable	The name table hash where key - node name, value list of indexes.
Node	node	Node to register.
System.Text.RegularExpressions.Regex	regex	The Regex type instance.

RestoreConnections(ArrayList)

Restores the connections.

Declaration

public static void RestoreConnections(ArrayList portConnections)

Parameters

Type	Name	Description
System.Collections.ArrayList	portConnections	The port connections.

SaveConnections(NodeCollection)

Saves the connections.

Declaration

public static ArrayList SaveConnections(NodeCollection nodes)

Parameters

Type	Name	Description
NodeCollection	nodes	The nodes.

Returns

Type	Description
System.Collections.ArrayList	The connections list.

ShouldGenerateNewIndex(Hashtable, String, Regex)

Evaluates whether new index for given node name should be generated.

Declaration

public static bool ShouldGenerateNewIndex(Hashtable nameTable, string strNodeName, Regex regex)

Parameters

Type	Name	Description
System.Collections.Hashtable	nameTable	The name table hash where key - node name, value list of indexes.
System.String	strNodeName	Node name.
System.Text.RegularExpressions.Regex	regex	The Regex type instance.

Returns

Type	Description
System.Boolean	true- new index should be generated, otherwise no.

SplitNodeName(String, Regex)

Split the name of the node to two part where first is a rootName and second is name index.

Declaration

public static string[] SplitNodeName(string nodeName, Regex regex)

Parameters

Type	Name	Description
System.String	nodeName	Name of the node.
System.Text.RegularExpressions.Regex	regex	The Regex type instance.

Returns

Type	Description
System.String[]	Array of string what contains two elements, rootName and index

UnregisterNode(Hashtable, Node, Regex)

Unregister the name of the node form name table.

Declaration

public static void UnregisterNode(Hashtable nameTable, Node node, Regex regex)

Parameters

Type	Name	Description
System.Collections.Hashtable	nameTable	The name table hash where key - node name, value list of indexes.
Node	node	Node to unregister.
System.Text.RegularExpressions.Regex	regex	The Regex type instance.