Skip to content

Action Event

Description

Occurs when a docking pane is performing an action.

Syntax

Public Event Action( _
    ByVal Action As DockingPaneAction, _
    ByVal Pane As Pane, _
    ByVal Container As PaneActionContainer, _
    ByRef Cancel As Boolean _
)

Parameters

  • Action

The action of the docking pane. Possible values include:

  • PaneActionFloating: Docking pane is currently floating. This occurs when the user clicks on the title bar of a docking pane and drags the pane to another location.
  • PaneActionFloated: Docking pane has been docked and is currently floating.
  • PaneActionClosing: Docking pane is currently closing. This occurs when the close button of the pane is clicked.
  • PaneActionClosed: Docking pane has been closed. This occurs when the docking pane has finished closing.
  • PaneActionDocking: Docking pane is in the process of docking.
  • PaneActionDocked: Docking pane has been docked. This occurs when the docking pane has finished docking.
  • PaneActionAttaching: Docking pane is in the process of attaching to another pane.
  • PaneActionAttached: Docking pane has been attached. This occurs when the docking pane has finished attaching to another pane.
  • PaneActionPinning: Docking pane is currently pinning. This occurs when the "pin" button is clicked to make the pane remain visible.
  • PaneActionPinned: Docking pane has been pinned. This occurs when the docking pane has finished pinning.
  • PaneActionCollapsing: Docking pane is currently collapsing (hiding). This occurs when a pane is going back to its AutoHide position.
  • PaneActionCollapsed: Docking pane has been collapsed. This occurs when the docking pane has finished collapsing.
  • PaneActionExpanding: Docking pane is currently expanding. This occurs when a pane is being displayed from its AutoHide position.
  • PaneActionExpanded: Docking pane is expanded; this is when the pane is fully shown from the autohide position.
  • PaneActionActivated: Docking Pane becomes active. After this action, the ActivePane property will hold a reference to the currently active pane.
  • PaneActionDeactivated: Docking Pane becomes deactivated. After this action, the ActivePane property becomes Null/Nothing.
  • PaneActionDetaching: Docking Pane is removed from a group of panes. This occurs when a pane that is in a group of two or more panes is dragged from the group.
  • PaneActionDragging: Docking Pane has started to be dragged. This occurs when a pane first starts to be dragged.
  • PaneActionUnpinning: Docking Pane is in the process of un-pinning. This occurs when the pin button of a pane is clicked to un-pin the pane. This is also known as auto-hide mode.
  • PaneActionUnpinned: Docking Pane is un-pinned. This occurs when a pane has completely been pinned. The pane will now only show a tab on the side of the container that can be displayed by moving the mouse over the tab. This is also known as auto-hide mode.
  • PaneActionSplitterResizing: Docking pane splitter resizing.
  • PaneActionSplitterResized: Docking pane splitter resized.

See Also

Example

Refer to the Container Sample for practical implementation.

Copyright (c) 1998-2024 Codejock Technologies. All rights reserved.