DockedState Property

Returns the current docking state of the pane. This property is read-only.

Syntax

Visual Basic

'Declaration
 
Public ReadOnly Property DockedState As DockedState

C#

public DockedState DockedState {get;}

Remarks

This property returns either DockedState.Docked or DockedState.Floating, depending on the current condition of the pane.

Example

The following code uses the InitializePane event to initialize values on the dock areas created automatically as a pane is repositioned by the user.

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.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinDock

Private Sub ultraDockManager1_InitializePane(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinDock.InitializePaneEventArgs) Handles ultraDockManager1.InitializePane

    ' InitializePane is fired when the pane is first deserialized or created.
    '

    ' Initialize some values for panes created by the dockmanager
    ' as the user repositions panes
    If (e.CreatedAutomatically) Then
        If TypeOf e.Pane Is DockAreaPane Then
            Dim dockArea As DockAreaPane = CType(e.Pane, DockAreaPane)

            If (dockArea.DockedState = DockedState.Floating) Then
                dockArea.GroupSettings.CaptionLocation = Infragistics.Win.UltraWinDock.Location.Left
                dockArea.DefaultPaneSettings.ShowCaption = DefaultableBoolean.False
                dockArea.Settings.ShowCaption = DefaultableBoolean.True
                dockArea.Text = "Floating Window"
            End If
        End If

        e.Pane.Settings.BorderStyleCaption = UIElementBorderStyle.Etched
    End If

End Sub

C#

using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinDock;
using System.Diagnostics;

private void ultraDockManager1_InitializePane(object sender, Infragistics.Win.UltraWinDock.InitializePaneEventArgs e)
{

	// InitializePane is fired when the pane is first deserialized or created.
	//

	// Initialize some values for panes created by the dockmanager
	// as the user repositions panes
	if (e.CreatedAutomatically)
	{
		if (e.Pane is DockAreaPane)
		{
			DockAreaPane dockArea  = e.Pane as DockAreaPane;

			if (dockArea.DockedState == DockedState.Floating) 
			{
				dockArea.GroupSettings.CaptionLocation = Infragistics.Win.UltraWinDock.Location.Left;
				dockArea.DefaultPaneSettings.ShowCaption = DefaultableBoolean.False;
				dockArea.Settings.ShowCaption = DefaultableBoolean.True;
				dockArea.Text = "Floating Window";
			}
		}
	}

	e.Pane.Settings.BorderStyleCaption = UIElementBorderStyle.Etched;

}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, 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