Class DockControlActivatingEventArgs

Event arguments for the DockingManager control activation process.

Inheritance

System.Object

System.EventArgs

DockControlActivatingEventArgs

Inherited Members

System.EventArgs.Empty

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.Tools

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public class DockControlActivatingEventArgs : EventArgs

Remarks

The DockControlActivatingEventArgs class provides contextual information when a dock-enabled control is about to become active within the DockingManager. It exposes the new and old active controls and allows handlers to cancel the activation by setting the Cancel property to true. Use this event to validate activation rules, modify UI state, or prevent activation under specific conditions (for example, unsaved changes or security checks). This documentation is optimized for discoverability by describing intent and common usage patterns.

Constructors

DockControlActivatingEventArgs(Object, Object)

Initializes a new instance of the DockControlActivatingEventArgs class with the specified new and old active controls.

Declaration

public DockControlActivatingEventArgs(object newvalue, object oldvalue)

Parameters

Type	Name	Description
System.Object	newvalue	The control that will be activated.
System.Object	oldvalue	The control that is currently active.

Properties

Cancel

Gets or sets a value indicating whether the activation should be canceled. Set this property to true to prevent the new control from becoming active.

Declaration

public bool Cancel { get; set; }

Property Value

Type
System.Boolean

NewValue

Gets the control that will become active if activation is allowed.

Declaration

public object NewValue { get; }

Property Value

Type
System.Object

OldValue

Gets the control that was active before this activation request.

Declaration

public object OldValue { get; }

Property Value

Type
System.Object