WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class DockAllowEventArgs

    Show / Hide Table of Contents

    Class DockAllowEventArgs

    Custom cancellable event argument class used for the DockAllow event.

    Inheritance
    System.Object
    DockAllowEventArgs
    Namespace: Syncfusion.Windows.Forms.Tools
    Assembly: Syncfusion.Tools.Windows.dll
    Syntax
    public class DockAllowEventArgs : CancelEventArgs
    Remarks

    The DockingManager uses the DockAllow event to provide information about an impending dock operation and provides a chance to accept/cancel the dock based on the participating controls and the style.

    Constructors

    DockAllowEventArgs(Control, Control, DockingStyle)

    Creates a new instance of the DockAllowEventArgs class.

    Declaration
    public DockAllowEventArgs(Control ctrldrag, Control ctrltarget, DockingStyle style)
    Parameters
    Type Name Description
    System.Windows.Forms.Control ctrldrag

    The control being dragged.

    System.Windows.Forms.Control ctrltarget

    The target control.

    DockingStyle style

    The dock style.

    Fields

    ctrlDrag

    Declaration
    protected Control ctrlDrag
    Field Value
    Type Description
    System.Windows.Forms.Control

    ctrlTarget

    Declaration
    protected Control ctrlTarget
    Field Value
    Type Description
    System.Windows.Forms.Control

    dStyle

    Declaration
    protected DockingStyle dStyle
    Field Value
    Type Description
    DockingStyle

    Properties

    DockStyle

    Returns the dock operation style.

    Declaration
    public DockingStyle DockStyle { get; }
    Property Value
    Type Description
    DockingStyle

    A DockingStyle value that represents the style of the dock operation.

    DragControl

    Returns the control being dragged.

    Declaration
    public Control DragControl { get; }
    Property Value
    Type Description
    System.Windows.Forms.Control

    A Control object that represents the control being dragged.

    TargetControl

    Returns the dock target control.

    Declaration
    public Control TargetControl { get; }
    Property Value
    Type Description
    System.Windows.Forms.Control

    A Control object that represents the target control for the dock.

    See Also

    DockAllowEventHandler
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved