PaneFromKey Method

Returns the pane with the specified key.

Syntax

Visual Basic

public DockablePaneBase PaneFromKey( 
   string key
)

C#

'Declaration
 
Public Function PaneFromKey( _
   ByVal key As String _
) As DockablePaneBase

 

Parameters

key

Key of the pane to return

Return Value

A pane which has the specified key or null if none were found.

Example

The following example demonstrates the various methods for pinning one or more DockableControlPane instances.

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinDock

Private Sub btnPinAll_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btnPinAll.Click

    ' There are several options for re-pinning unpinned
    ' DockableControlPanes.

    ' You can re-pin an individual DockableControlPane
    Me.ultraDockManager1.PaneFromKey("treeSolutions").Pin()

    ' You can re-pin all the descendants/children of a particular 
    ' group pane. Note, since a DockAreaPane is a specialized
    ' DockableGroupPane, you can call the method on a
    ' dock area
    If Me.ultraDockManager1.DockAreas(0).DockedState = DockedState.Docked Then
        Me.ultraDockManager1.DockAreas(0).Pin()
    End If

    ' Or you can re-pin all unpinned panes
    Me.ultraDockManager1.PinAll()

End Sub

'Declaration
 
Public Function PaneFromKey( _
   ByVal key As String _
) As DockablePaneBase

 

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

private void btnPinAll_Click(object sender, System.EventArgs e)
{

	// There are several options for re-pinning unpinned
	// DockableControlPanes.

	// You can re-pin an individual DockableControlPane
	this.ultraDockManager1.PaneFromKey("treeSolutions").Pin();

	// You can re-pin all the descendants/children of a particular 
	// group pane. Note, since a DockAreaPane is a specialized
	// DockableGroupPane, you can call the method on a
	// dock area
	if (this.ultraDockManager1.DockAreas[0].DockedState == DockedState.Docked)
		this.ultraDockManager1.DockAreas[0].Pin();

	// Or you can re-pin all unpinned panes
	this.ultraDockManager1.PinAll();

}

'Declaration
 
Public Function PaneFromKey( _
   ByVal key As String _
) As DockablePaneBase

 

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