PaneDragStarting Event

Occurs when one or more ContentPane instances are being dragged

Syntax

Visual Basic

'Declaration
 
Public Event PaneDragStarting As EventHandler(Of PaneDragStartingEventArgs)

C#

public event EventHandler<PaneDragStartingEventArgs> PaneDragStarting

Event Data

The event handler receives an argument of type PaneDragStartingEventArgs containing data related to this event. The following PaneDragStartingEventArgs properties provide information specific to this event.

Property	Description
AllowDockingIndicatorsWithinDocumentContentHost	Returns or sets a boolean indicating whether docking indicators may be displayed for Infragistics.Windows.DockManager.TabGroupPane instances within the Infragistics.Windows.DockManager.DocumentContentHost
Cancel (Inherited from Infragistics.Windows.Controls.Events.CancelableRoutedEventArgs)
Handled (Inherited from System.Windows.RoutedEventArgs)	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route.
InvalidDragActionCursor	The cursor that should be displayed by default when the mouse is over an invalid drop location during the drag operation.
OriginalSource (Inherited from System.Windows.RoutedEventArgs)	Gets the original reporting source as determined by pure hit testing, before any possible System.Windows.RoutedEventArgs.Source adjustment by a parent class.
Panes	Returns the collection of panes being dragged.
PreventDockingWhileControlKeyIsPressed	Returns or sets a boolean indicating whether docking is allowed while the control key is pressed.
RaisePaneDragOverForInvalidLocations	Indicates if the PaneDragOver event should be raised even when the mouse is moved over an invalid pane location based on the properties of the panes being dragged.
RootPane	Returns the root element that is being dragged.
RoutedEvent (Inherited from System.Windows.RoutedEventArgs)	Gets or sets the System.Windows.RoutedEventArgs.RoutedEvent associated with this System.Windows.RoutedEventArgs instance.
Source (Inherited from System.Windows.RoutedEventArgs)	Gets or sets a reference to the object that raised the event.
ValidDragActionCursor	The cursor that should be displayed by default when the mouse is over a valid drop location during the drag operation.

Example

This sample demonstrates using the PaneDragStarting event to initialize the cursors. The code samples assume you have a configuration similar to that shown in the xaml snippet.

For an overview of how to handle events in Visual Basic or Visual C#, see Event Handlers in Visual Basic and Visual C#. For specific information and code examples illustrating how to consume events in your application, see Consuming Events in the .NET Framework Developer's Guide.

Visual Basic

Imports Infragistics.Windows.DockManager
Imports Infragistics.Windows.DockManager.Events

Private Sub XamDockManager_PaneDragStarting(ByVal sender As Object, ByVal e As PaneDragStartingEventArgs)
    ' these two properties can be used to initialize the default 
    ' cursors used when over an invalid or valid drop location 
    ' respectively. by default the PaneDragOver is not raised 
    ' for invalid locations so for most cases this is the only 
    ' way to initialize the invalid drop cursor 
    e.InvalidDragActionCursor = Cursors.No
    e.ValidDragActionCursor = Cursors.Arrow

    ' you can have the PaneDragOver get raised for all drop 
    ' locations by setting RaisePaneDragOverForInvalidLocations 
    ' note however that this means that the docking indicators 
    ' will be shown over all panes - even those for which the 
    ' dragged panes properties do not allow it by default. 
    e.RaisePaneDragOverForInvalidLocations = True

    ' you can see the panes that will be dragged 
    ' and if necessary, you can prevent the drag 
    ' operation from starting. 
    'e.Cancel = true; 
    For Each pane As ContentPane In e.Panes
    Next
End Sub

C#

using Infragistics.Windows.DockManager;
using Infragistics.Windows.DockManager.Events;

private void XamDockManager_PaneDragStarting(object sender, PaneDragStartingEventArgs e)
{
	// these two properties can be used to initialize the default
	// cursors used when over an invalid or valid drop location
	// respectively. by default the PaneDragOver is not raised
	// for invalid locations so for most cases this is the only
	// way to initialize the invalid drop cursor
	e.InvalidDragActionCursor = Cursors.No;
	e.ValidDragActionCursor = Cursors.Arrow;

	// you can have the PaneDragOver get raised for all drop
	// locations by setting RaisePaneDragOverForInvalidLocations
	// note however that this means that the docking indicators
	// will be shown over all panes - even those for which the
	// dragged panes properties do not allow it by default.
	e.RaisePaneDragOverForInvalidLocations = true;

	// you can see the panes that will be dragged
	foreach (ContentPane pane in e.Panes)
	{
		// and if necessary, you can prevent the drag
		// operation from starting.
		//e.Cancel = true;
	}
}

XAML

<igDock:XamDockManager PaneDragStarting="XamDockManager_PaneDragStarting">
    <igDock:XamDockManager.Panes>
        <igDock:SplitPane>
            <igDock:ContentPane Header="Test Pane" AllowDockingRight="False" />
        </igDock:SplitPane>
        <igDock:SplitPane igDock:XamDockManager.InitialLocation="DockedRight">
            <igDock:ContentPane Header="Don't Allow" />
        </igDock:SplitPane>
    </igDock:XamDockManager.Panes>
</igDock:XamDockManager>

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2