Version

NavigatorSettings Class

Contains various properties related to the Navigator functionality of the UltraDockManager.
Syntax
'Declaration
 
Public Class NavigatorSettings 
   Inherits Infragistics.Shared.SubObjectBase
public class NavigatorSettings : Infragistics.Shared.SubObjectBase
Remarks

The Navigator feature of the UltraDockManager provides an intuitive user interface for activating a pane or MDI child window managed by the UltraDockManager, as seen in Visual Studio 2005. This functionality is enabled by pressing Ctrl + Tab when the UltraDockManager's UltraDockManager.HostControl is an MDI parent form (i.e. the form's IsMdiContainer property returns true). If the UltraDockManager's host control is not an MDI parent form, the Navigator interface can be displayed by calling the UltraDockManager.ShowNavigator method on the UltraDockManager.

The NavigatorSettings class contains properties that provide fine-grained control over various settings used by the Navigator user interface. For example, the Appearance property determines the general visual settings used all of the controls on the Navigator form. The ShowDescriptionArea property allows you to hide the area beneath the lists of items which provides detailed information regarding the currently selected item in the lists. The Enabled property can be set to false to prevent the Navigator user interface from displaying when the end-user presses Ctrl + Tab.


The UltraDockManager.HostControl of the UltraDockManager must be an MDI parent form for the Navigator user interface to be accessed by pressing Ctrl + Tab.

The UltraDockManager has several Navigator-related events that can be used to customize the runtime behavior of the Navigator feature:

  • BeforeNavigatorDisplayed - Fires after the end-user summons the Navigator (via Ctrl + Tab), but before the Navigator is displayed. The event argument provides a Cancel property which can be used to suppress the Navigator UI from being displayed.
  • InitializeNavigatorItem - Fires once for each item that appears in the Navigator lists. This event allows developers to supply the icon to display next to an item (assuming that the default image is not appropriate). Another property on the event argument specifies whether the item being initialized is in the list of Panes or MDI children. The developer can specify the display text for an item here as well.
  • InitializeNavigatorItemDescription - Fires once for each item listed in the Navigator user interface, but only when the item has been selected by the end-user. Handlers of this event can specify text to be displayed in the description area on the bottom of the Navigator form. This event only fires if the ShowDescriptionArea property on the NavigatorSettings returns true.
  • AfterNavigatorClosed - Fires immediately after the Navigator form has closed.

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

See Also