Close(Boolean) Method

Closes the pane and all of its descendant panes that have the same DockedState.

Syntax

Visual Basic

'Declaration
 
Public Overloads Overridable Sub Close( _
   ByVal closeChildPane As Boolean _
) 

C#

public virtual void Close( 
   bool closeChildPane
)

Parameters

closeChildPane

If True, all child panes will be closed.

Remarks

Invoking this method is the equivalent of clicking the "X" button in the pane's caption area.

Example

The following example demonstrates the various methods for hiding/closing one or more panes.

Visual Basic

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

Private Sub btnHideAll_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btnHideAll.Click

    ' There are several options for hiding/closing panes

    ' You can close a particular control pane. Setting the closed
    ' property has the same affect in this case.
    ' Me.ultraDockManager1.PaneFromControl(Me.UltraDayView1).Closed = True
    Me.ultraDockManager1.ControlPanes("treeSolutions").Close()

    ' You can close a particular group. Calling the parameterless
    ' overload is equivalent to calling the following:
    ' Me.ultraDockManager1.DockAreas(0).Close(false)
    ' which indicates that only the specified pane's 'Closed' property
    ' should be set. If true is specified, the 'Closed' property
    ' of all the children/descendants of the pane is also set
    ' to true.
    Me.ultraDockManager1.DockAreas(0).Close()

    ' The following goes through and sets the 'Closed' property
    'of all panes to false
    Me.ultraDockManager1.HideAll()

End Sub

C#

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

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

	// There are several options for hiding/closing panes

	// You can close a particular control pane. Setting the closed
	// property has the same affect in this case.
	// this.ultraDockManager1.PaneFromControl(this.ultraDayView1).Closed = true;
	this.ultraDockManager1.ControlPanes["treeSolutions"].Close();

	// You can close a particular group. Calling the parameterless
	// overload is equivalent to calling the following:
	// this.ultraDockManager1.DockAreas[0].Close(false);
	// which indicates that only the specified pane's 'Closed' property
	// should be set. If true is specified, the 'Closed' property
	// of all the children/descendants of the pane is also set
	// to true.
	this.ultraDockManager1.DockAreas[0].Close();

	// The following goes through and sets the 'Closed' property
	//of all panes to false
	this.ultraDockManager1.HideAll();

}

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