skip navigation
  • Product Bundles

    DevCraft

    All Telerik .NET tools and Kendo UI JavaScript components in one package. Now enhanced with:

    • NEW: Design Kits for Figma
    • Online Training
    • Document Processing Library
    • Embedded Reporting for web and desktop

    Web

    Kendo UI UI for jQuery UI for Angular UI for React UI for Vue UI for Blazor UI for ASP.NET Core UI for ASP.NET MVC UI for ASP.NET AJAX

    Mobile

    UI for .NET MAUI

    Document Management

    Telerik Document Processing

    Desktop

    UI for .NET MAUI UI for WinUI UI for WinForms UI for WPF

    Reporting

    Telerik Reporting Telerik Report Server

    Testing & Mocking

    Test Studio Test Studio Dev Edition Telerik JustMock

    CMS

    Sitefinity

    UI/UX Tools

    ThemeBuilder Design System Kit Templates and Building Blocks

    Debugging

    Fiddler Fiddler Everywhere Fiddler Classic Fiddler Everywhere Reporter FiddlerCore

    Free Tools

    VB.NET to C# Converter Testing Framework
    View all products
  • Overview
  • Demos
    • What's New
    • Roadmap
    • Release History
  • Support and Learning

    • Support and Learning Hub
    • First Steps
    • Docs
    • Demos
    • Virtual Classroom
    • Forums
    • Videos
    • Blogs
    • Accessibility
    • Submit a Ticket

    Productivity and Design Tools

    • Visual Studio Extensions
    • Visual Studio Templates
    • Embedded Reporting
  • Pricing
  • Shopping cart
    • Account Overview
    • Your Licenses
    • Downloads
    • Support Center
    • Forum Profile
    • Payment Methods
    • Edit Profile
    • Log out
  • Login
  • Contact Us
  • Try now

Class DockingNavigator

Control used for navigating and selecting panes in RadDocking. It can be opened with Ctrl + Tab combination similar to the IDE Navigator in Visual Studio.

Inheritance
System.Object
DockingNavigator
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Docking.dll

Syntax

public class DockingNavigator : Control, IThemable

Constructors

DockingNavigator()

Declaration
public DockingNavigator()

Fields

ActiveDocumentsListBoxHeaderProperty

Identifies the ActiveDocumentsListBoxHeader dependency property.

Declaration
public static readonly DependencyProperty ActiveDocumentsListBoxHeaderProperty
Field Value
System.Windows.DependencyProperty

ActiveDocumentsListBoxStyleProperty

Identifies the ActiveDocumentsListBoxStyle dependency property.

Declaration
public static readonly DependencyProperty ActiveDocumentsListBoxStyleProperty
Field Value
System.Windows.DependencyProperty

ActivePanesListBoxHeaderProperty

Identifies the ActivePanesListBoxHeader dependency property.

Declaration
public static readonly DependencyProperty ActivePanesListBoxHeaderProperty
Field Value
System.Windows.DependencyProperty

ActivePanesListBoxStyleProperty

Identifies the ActivePanesListBoxStyle dependency property.

Declaration
public static readonly DependencyProperty ActivePanesListBoxStyleProperty
Field Value
System.Windows.DependencyProperty

DescriptionProperty

Identifies the Description attached property of the DockingNavigator.

Declaration
public static readonly DependencyProperty DescriptionProperty
Field Value
System.Windows.DependencyProperty

DescriptionStringFormatProperty

Identifies the DescriptionStringFormat dependency property.

Declaration
public static readonly DependencyProperty DescriptionStringFormatProperty
Field Value
System.Windows.DependencyProperty

DescriptionTemplateProperty

Identifies the DescriptionTemplate dependency property.

Declaration
public static readonly DependencyProperty DescriptionTemplateProperty
Field Value
System.Windows.DependencyProperty

DescriptionTemplateSelectorProperty

Identifies the DescriptionTemplateSelector dependency property.

Declaration
public static readonly DependencyProperty DescriptionTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty

FooterProperty

Identifies the Footer attached property of the DockingNavigator.

Declaration
public static readonly DependencyProperty FooterProperty
Field Value
System.Windows.DependencyProperty

FooterStringFormatProperty

Identifies the FooterStringFormat dependency property.

Declaration
public static readonly DependencyProperty FooterStringFormatProperty
Field Value
System.Windows.DependencyProperty

FooterTemplateProperty

Identifies the FooterTemplate dependency property.

Declaration
public static readonly DependencyProperty FooterTemplateProperty
Field Value
System.Windows.DependencyProperty

FooterTemplateSelectorProperty

Identifies the FooterTemplateSelector dependency property.

Declaration
public static readonly DependencyProperty FooterTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty

HeaderProperty

Identifies the Header attached property of the DockingNavigator.

Declaration
public static readonly DependencyProperty HeaderProperty
Field Value
System.Windows.DependencyProperty

HeaderStringFormatProperty

Identifies the HeaderStringFormat dependency property.

Declaration
public static readonly DependencyProperty HeaderStringFormatProperty
Field Value
System.Windows.DependencyProperty

HeaderTemplateProperty

Identifies the HeaderTemplate dependency property.

Declaration
public static readonly DependencyProperty HeaderTemplateProperty
Field Value
System.Windows.DependencyProperty

HeaderTemplateSelectorProperty

Identifies the HeaderTemplateSelector dependency property.

Declaration
public static readonly DependencyProperty HeaderTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty

IconProperty

Identifies the Icon attached property of the DockingNavigator.

Declaration
public static readonly DependencyProperty IconProperty
Field Value
System.Windows.DependencyProperty

IconTemplateProperty

Identifies the IconTemplate dependency property.

Declaration
public static readonly DependencyProperty IconTemplateProperty
Field Value
System.Windows.DependencyProperty

IconTemplateSelectorProperty

Identifies the IconTemplateSelector dependency property.

Declaration
public static readonly DependencyProperty IconTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty

ItemTemplateSelectorProperty

Identifies the ItemTemplateSelector dependency property.

Declaration
public static readonly DependencyProperty ItemTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty

PreviewHeaderProperty

Identifies the PreviewHeader dependency property.

Declaration
public static readonly DependencyProperty PreviewHeaderProperty
Field Value
System.Windows.DependencyProperty

PreviewHeightProperty

Identifies the PreviewHeight dependency property.

Declaration
public static readonly DependencyProperty PreviewHeightProperty
Field Value
System.Windows.DependencyProperty

PreviewWidthProperty

Identifies the PreviewWidth dependency property.

Declaration
public static readonly DependencyProperty PreviewWidthProperty
Field Value
System.Windows.DependencyProperty

Properties

ActiveDocumentsListBoxHeader

Gets or sets the header of the active documents panes ListBox.

Declaration
public string ActiveDocumentsListBoxHeader { get; set; }
Property Value
System.String

ActiveDocumentsListBoxStyle

Gets or sets the Style for the active documents ListBox.

Declaration
public Style ActiveDocumentsListBoxStyle { get; set; }
Property Value
System.Windows.Style

ActivePanesListBoxHeader

Gets or sets the header of the active panes ListBox.

Declaration
public string ActivePanesListBoxHeader { get; set; }
Property Value
System.String

ActivePanesListBoxStyle

Gets or sets the Style for the active panes ListBox.

Declaration
public Style ActivePanesListBoxStyle { get; set; }
Property Value
System.Windows.Style

DescriptionStringFormat

Gets or sets the string format of the description presenter.

Declaration
public string DescriptionStringFormat { get; set; }
Property Value
System.String

DescriptionTemplate

Gets or sets the content template of the description presenter.

Declaration
public DataTemplate DescriptionTemplate { get; set; }
Property Value
System.Windows.DataTemplate

DescriptionTemplateSelector

Gets or sets the content template selector of the description presenter.

Declaration
public DataTemplateSelector DescriptionTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector

FooterStringFormat

Gets or sets the string format of the footer presenter.

Declaration
public string FooterStringFormat { get; set; }
Property Value
System.String

FooterTemplate

Gets or sets the content template of the footer presenter.

Declaration
public DataTemplate FooterTemplate { get; set; }
Property Value
System.Windows.DataTemplate

FooterTemplateSelector

Gets or sets the content template selector of the footer presenter.

Declaration
public DataTemplateSelector FooterTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector

HeaderStringFormat

Gets or sets the string format of the header presenter.

Declaration
public string HeaderStringFormat { get; set; }
Property Value
System.String

HeaderTemplate

Gets or sets the content template of the header presenter.

Declaration
public DataTemplate HeaderTemplate { get; set; }
Property Value
System.Windows.DataTemplate

HeaderTemplateSelector

Gets or sets the content template selector of the header presenter.

Declaration
public DataTemplateSelector HeaderTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector

IconTemplate

Gets or sets the content template of the icon presenter.

Declaration
public DataTemplate IconTemplate { get; set; }
Property Value
System.Windows.DataTemplate

IconTemplateSelector

Gets or sets the content template selector of the icon presenter.

Declaration
public DataTemplateSelector IconTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector

ItemTemplateSelector

Gets or sets the item template selector for this navigator instance.

Declaration
public DockingNavigatorItemTemplateSelector ItemTemplateSelector { get; set; }
Property Value
DockingNavigatorItemTemplateSelector

PreviewHeader

Gets or sets the header of the preview image.

Declaration
public string PreviewHeader { get; set; }
Property Value
System.String

PreviewHeight

Gets or sets the height of the preview image.

Declaration
public double PreviewHeight { get; set; }
Property Value
System.Double

PreviewWidth

Gets or sets the width of the preview image.

Declaration
public double PreviewWidth { get; set; }
Property Value
System.Double

SelectDocumentPaneOnLoad

Gets or sets whether the navigator will select document pane item on load.

Declaration
protected bool SelectDocumentPaneOnLoad { get; set; }
Property Value
System.Boolean

Methods

GetDescription(DependencyObject)

Gets the Description of the pane used in DockingNavigator.

Declaration
public static object GetDescription(DependencyObject obj)
Parameters
System.Windows.DependencyObject obj

Returns
System.Object

GetFooter(DependencyObject)

Gets the Footer of the pane used in DockingNavigator.

Declaration
public static object GetFooter(DependencyObject obj)
Parameters
System.Windows.DependencyObject obj

Returns
System.Object

GetHeader(DependencyObject)

Gets the Header of the pane used in DockingNavigator.

Declaration
public static object GetHeader(DependencyObject obj)
Parameters
System.Windows.DependencyObject obj

Returns
System.Object

GetIcon(DependencyObject)

Gets the Icon of the pane used in DockingNavigator.

Declaration
public static object GetIcon(DependencyObject obj)
Parameters
System.Windows.DependencyObject obj

Returns
System.Object

Initialize()

Called when view model is created for the navigator control and opening event is fired.

Declaration
protected virtual bool Initialize()
Returns
System.Boolean

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate.

Declaration
public override void OnApplyTemplate()

OnClosed()

Called when the popup is closed.

Declaration
protected virtual void OnClosed()

OnCreateAutomationPeer()

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event and sets System.Windows.FrameworkElement.DefaultStyleKey from the active theme.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

OnKeyUp(KeyEventArgs)

Invoked when an unhandled System.Windows.Input.Keyboard.KeyUp attached event reaches an element in its route that is derived from this class.

Declaration
protected override void OnKeyUp(KeyEventArgs e)
Parameters
System.Windows.Input.KeyEventArgs e

OnOpening(NavigatorOpeningEventArgs)

Called before the popup is opened.

Declaration
protected virtual void OnOpening(NavigatorOpeningEventArgs args)
Parameters
NavigatorOpeningEventArgs args

OnUpdatePreview()

Called when the preview image of the navigator is being updated.

Declaration
protected virtual void OnUpdatePreview()

SetDescription(DependencyObject, Object)

Sets the Description of the pane used in DockingNavigator.

Declaration
public static void SetDescription(DependencyObject obj, object value)
Parameters
System.Windows.DependencyObject obj

System.Object value

SetFooter(DependencyObject, Object)

Sets the Footer of the pane used in DockingNavigator.

Declaration
public static void SetFooter(DependencyObject obj, object value)
Parameters
System.Windows.DependencyObject obj

System.Object value

SetHeader(DependencyObject, Object)

Sets the Header of the pane used in DockingNavigator.

Declaration
public static void SetHeader(DependencyObject obj, object value)
Parameters
System.Windows.DependencyObject obj

System.Object value

SetIcon(DependencyObject, Object)

Sets the Icon of the pane used in DockingNavigator.

Declaration
public static void SetIcon(DependencyObject obj, object value)
Parameters
System.Windows.DependencyObject obj

System.Object value

ShouldOpen(KeyEventArgs)

Determines whether the navigator should be opened based on the keyboard input.

Declaration
protected virtual bool ShouldOpen(KeyEventArgs args)
Parameters
System.Windows.Input.KeyEventArgs args

Keyboard event args.

Returns
System.Boolean

True if the navigator should be opened.

Events

Closed

Occurs when docking navigator is closed.

Declaration
public event EventHandler<NavigatorClosedEventArgs> Closed
Event Type
System.EventHandler<NavigatorClosedEventArgs>

Opening

Occurs when docking navigator is about to open.

Declaration
public event EventHandler<NavigatorOpeningEventArgs> Opening
Event Type
System.EventHandler<NavigatorOpeningEventArgs>

Extension Methods

CollectionExtensions.ToEnumerable<T>(T)
EnumerableExtensions.ToEnumerable<T>(T)
Getting Started
  • Install Now
  • Demos
  • SDK Samples Browser
  • Sample Applications
Support Resources
  • Code Library
  • Knowledge Base
  • MVVM Support
  • Videos
  • GitHub SDK Repository
Community
  • Forums
  • Blogs
  • XAML Feedback Portal
  • Document Processing Feedback Portal

Copyright © 2018 Progress Software Corporation and/or its subsidiaries or affiliates.
All Rights Reserved.

Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries. See Trademarks for appropriate markings.