Class ZOrderCmd

Change the Z-order of one or more nodes.

Inheritance
System.Object
ZOrderCmd
Implements
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 ZOrderCmd : ICommand
Remarks

Z-order determines the order in which nodes are rendered and affects how nodes overlap.

Constructors

ZOrderCmd(Node, ZOrderUpdate)

Initializes a new instance of the ZOrderCmd class.

Declaration
public ZOrderCmd(Node nodeAffected, ZOrderUpdate changeType)
Parameters
Type Name Description
Node nodeAffected

Node which ZOrder has changed.
ZOrderUpdate changeType

Specifies how Z-order will be changed.

Properties

CanUndo

Gets a value indicating whether or not the command supports undo.

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

true, if can undo.

Description

Gets short, user-friendly description of the command.

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

The description.

Methods

CanMerge(ICommand)

Determines whether this instance can merge the specified command to previous recorded command.

Declaration
public bool CanMerge(ICommand cmd)
Parameters
Type Name Description
ICommand cmd

The command to merge.
Returns
Type Description
System.Boolean

true if this instance can merge the specified command to last recorded command; otherwise, false.

Do(Object)

Executes the ZOrderCmd.

Declaration
public bool Do(object cmdTarget)
Parameters
Type Name Description
System.Object cmdTarget

Not used.
Returns
Type Description
System.Boolean

True if successful; otherwise False.
Remarks

Loops through the nodes attached to the command and changes the Z-order of each node. The type of change made to the Z-order is specified by the ZOrderUpdate parameter passed in the constructor. The parent of each node must support the IZOrderContainer service.

IZOrderContainer ZOrderUpdate

Merge(ICommand)

Merges the specified command with last recorded user operation.

Declaration
public void Merge(ICommand cmd)
Parameters
Type Name Description
ICommand cmd

The command to merge.

Undo()

Restores the Z-order of the attached nodes back to their original position.

Declaration
public bool Undo()
Returns
Type Description
System.Boolean

True if successful; otherwise False.

Implements