NavigationFrame Class
The flat-styled page container without built-in navigation elements (unlike the TabPane), displaying one page at a time.
Supports animation effects when navigating through pages.
See Navigation Frame and Tab Pane.
Namespace: DevExpress.XtraBars.Navigation
Assembly: DevExpress.XtraBars.v19.1.dll
Declaration
[ToolboxBitmap(typeof(NavigationFrame), "NavigationFrame")]
[SmartTagSupport(typeof(NavigationFrameBounds), SmartTagSupportAttribute.SmartTagCreationMode.Auto)]
[SmartTagFilter(typeof(NavigationFrameFilter))]
[SmartTagAction(typeof(NavigationFrameActions), "Pages", "Pages", SmartTagActionType.CloseAfterExecute)]
[SmartTagAction(typeof(NavigationFrameActions), "AddNavigationPage", "Add Page")]
[SmartTagAction(typeof(NavigationFrameActions), "BringToFront", "Bring to front", 0, SmartTagActionType.CloseAfterExecute)]
[SmartTagAction(typeof(NavigationFrameActions), "SendToBack", "Send to back", 0, SmartTagActionType.CloseAfterExecute)]
[SmartTagAction(typeof(NavigationFrameActions), "DockInParentContainer", "Dock in parent container", 1, SmartTagActionType.CloseAfterExecute)]
[SmartTagAction(typeof(NavigationFrameActions), "UndockFromParentContainer", "Undock from parent container", 1, SmartTagActionType.CloseAfterExecute)]
[SmartTagAction(typeof(NavigationFrameActions), "RemoveNavigationPage", "Remove Page")]
public class NavigationFrame :
ControlBase,
ISupportLookAndFeel,
INavigationFrame,
ISupportBatchUpdate,
IDocumentAdapterFactory,
INavigationBarClient,
ISupportInitialize,
IDXControl,
ISupportPageNavigation
<ToolboxBitmap(GetType(NavigationFrame), "NavigationFrame")>
<SmartTagSupport(GetType(NavigationFrameBounds), SmartTagSupportAttribute.SmartTagCreationMode.Auto)>
<SmartTagFilter(GetType(NavigationFrameFilter))>
<SmartTagAction(GetType(NavigationFrameActions), "Pages", "Pages", SmartTagActionType.CloseAfterExecute)>
<SmartTagAction(GetType(NavigationFrameActions), "AddNavigationPage", "Add Page")>
<SmartTagAction(GetType(NavigationFrameActions), "BringToFront", "Bring to front", 0, SmartTagActionType.CloseAfterExecute)>
<SmartTagAction(GetType(NavigationFrameActions), "SendToBack", "Send to back", 0, SmartTagActionType.CloseAfterExecute)>
<SmartTagAction(GetType(NavigationFrameActions), "DockInParentContainer", "Dock in parent container", 1, SmartTagActionType.CloseAfterExecute)>
<SmartTagAction(GetType(NavigationFrameActions), "UndockFromParentContainer", "Undock from parent container", 1, SmartTagActionType.CloseAfterExecute)>
<SmartTagAction(GetType(NavigationFrameActions), "RemoveNavigationPage", "Remove Page")>
Public Class NavigationFrame
Inherits ControlBase
Implements ISupportLookAndFeel,
INavigationFrame,
ISupportBatchUpdate,
IDocumentAdapterFactory,
INavigationBarClient,
ISupportInitialize,
IDXControl,
ISupportPageNavigation
Navigation frame is a content container that creates a single document interface (SDI). The control possesses the NavigationFrame.Pages collection that stores NavigationPage objects. Each page is a singleton container, capable of displaying any custom content. To populate a page, use its Controls collection.
The navigation frame has no built-in visual elements to navigate through pages at runtime - no tab headers, navigation buttons etc. Navigation through pages must be implemented manually by assigning the required page to the frame’s NavigationFrame.SelectedPage property. In the animation below, this property is manually set when different AccordionControl items are clicked.
At design time, the frame displays navigation elements that allow you to toggle through currently existing navigation pages, create new ones or remove them (see the figure below). These elements simplify populating pages and cannot be displayed at runtime.
If the NavigationFrame.AllowTransitionAnimation property is enabled, navigating through pages is followed with an animation effect, specified by the NavigationFrame.TransitionType property.
The RadioGroup and WindowsUIButtonPanel can be used as a pager for the following controls:
The pager automatically splits the target control’s content into pages, and provides navigation buttons to scroll to corresponding pages.
The pager navigation functionality is implemented as a Behavior and can be added to your controls using the BehaviorManager component.
See Also