CloseNavigationPaneFlyout(Boolean) Method

Closes the navigation pane flyout.

Syntax

Visual Basic

'Declaration
 
Public Overloads Sub CloseNavigationPaneFlyout( _
   ByVal cancel As Boolean _
) 

C#

public void CloseNavigationPaneFlyout( 
   bool cancel
)

Parameters

cancel

Specifies whether the flyout session is to be canceled.

Remarks

When a group's Style property resolves to 'ControlContainer', the group typically hosts a UserControl. The UltraExplorerBar does not receive keyboard notifications when that UserControl or one of its children has the input focus; when that UserControl is situated on the navigation pane flyout, the Enter and Escape keys will not close the flyout as they do when the ExplorerBar has the input focus. The CloseNavigationPaneFlyout method enables the end developer to programmatically close the navigation pane flyout, as well as signify whether the result of the flyout session should be considered to be committed or canceled. Specifying true for the value of the 'cancel' parameter (i.e., when the method is called in response to the Escape key being pressed) causes the value of the NavigationPaneFlyoutClosedEventArgs.Canceled property to reflect the cancelation, so that the event handling code can react appropriately.

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