Back to all docs
API Reference / Telerik.Windows.Controls / DockingNavigator
New to Telerik UI for WPF? Start a free 30-day trial

DockingNavigator

Class

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.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Docking.dll

Syntax:
C#
public class DockingNavigator : Control

Inheritance: objectDockingNavigator

Constructors

DockingNavigator()

C#
public DockingNavigator()

Fields

ActiveDocumentsListBoxHeaderProperty

DependencyProperty

Identifies the ActiveDocumentsListBoxHeader dependency property.

C#
public static readonly DependencyProperty ActiveDocumentsListBoxHeaderProperty

ActiveDocumentsListBoxStyleProperty

DependencyProperty

Identifies the ActiveDocumentsListBoxStyle dependency property.

C#
public static readonly DependencyProperty ActiveDocumentsListBoxStyleProperty

ActivePanesListBoxHeaderProperty

DependencyProperty

Identifies the ActivePanesListBoxHeader dependency property.

C#
public static readonly DependencyProperty ActivePanesListBoxHeaderProperty

ActivePanesListBoxStyleProperty

DependencyProperty

Identifies the ActivePanesListBoxStyle dependency property.

C#
public static readonly DependencyProperty ActivePanesListBoxStyleProperty

DescriptionProperty

DependencyProperty

Identifies the Description attached property of the DockingNavigator.

C#
public static readonly DependencyProperty DescriptionProperty

DescriptionStringFormatProperty

DependencyProperty

Identifies the DescriptionStringFormat dependency property.

C#
public static readonly DependencyProperty DescriptionStringFormatProperty

DescriptionTemplateProperty

DependencyProperty

Identifies the DescriptionTemplate dependency property.

C#
public static readonly DependencyProperty DescriptionTemplateProperty

DescriptionTemplateSelectorProperty

DependencyProperty

Identifies the DescriptionTemplateSelector dependency property.

C#
public static readonly DependencyProperty DescriptionTemplateSelectorProperty

FooterProperty

DependencyProperty

Identifies the Footer attached property of the DockingNavigator.

C#
public static readonly DependencyProperty FooterProperty

FooterStringFormatProperty

DependencyProperty

Identifies the FooterStringFormat dependency property.

C#
public static readonly DependencyProperty FooterStringFormatProperty

FooterTemplateProperty

DependencyProperty

Identifies the FooterTemplate dependency property.

C#
public static readonly DependencyProperty FooterTemplateProperty

FooterTemplateSelectorProperty

DependencyProperty

Identifies the FooterTemplateSelector dependency property.

C#
public static readonly DependencyProperty FooterTemplateSelectorProperty

HeaderProperty

DependencyProperty

Identifies the Header attached property of the DockingNavigator.

C#
public static readonly DependencyProperty HeaderProperty

HeaderStringFormatProperty

DependencyProperty

Identifies the HeaderStringFormat dependency property.

C#
public static readonly DependencyProperty HeaderStringFormatProperty

HeaderTemplateProperty

DependencyProperty

Identifies the HeaderTemplate dependency property.

C#
public static readonly DependencyProperty HeaderTemplateProperty

HeaderTemplateSelectorProperty

DependencyProperty

Identifies the HeaderTemplateSelector dependency property.

C#
public static readonly DependencyProperty HeaderTemplateSelectorProperty

IconProperty

DependencyProperty

Identifies the Icon attached property of the DockingNavigator.

C#
public static readonly DependencyProperty IconProperty

IconTemplateProperty

DependencyProperty

Identifies the IconTemplate dependency property.

C#
public static readonly DependencyProperty IconTemplateProperty

IconTemplateSelectorProperty

DependencyProperty

Identifies the IconTemplateSelector dependency property.

C#
public static readonly DependencyProperty IconTemplateSelectorProperty

ItemTemplateSelectorProperty

DependencyProperty

Identifies the ItemTemplateSelector dependency property.

C#
public static readonly DependencyProperty ItemTemplateSelectorProperty

PreviewHeaderProperty

DependencyProperty

Identifies the PreviewHeader dependency property.

C#
public static readonly DependencyProperty PreviewHeaderProperty

PreviewHeightProperty

DependencyProperty

Identifies the PreviewHeight dependency property.

C#
public static readonly DependencyProperty PreviewHeightProperty

PreviewWidthProperty

DependencyProperty

Identifies the PreviewWidth dependency property.

C#
public static readonly DependencyProperty PreviewWidthProperty

Properties

ActiveDocumentsListBoxHeader

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

C#
public string ActiveDocumentsListBoxHeader { get; set; }

ActiveDocumentsListBoxStyle

Style

Gets or sets the Style for the active documents ListBox.

C#
public Style ActiveDocumentsListBoxStyle { get; set; }

ActivePanesListBoxHeader

Gets or sets the header of the active panes ListBox.

C#
public string ActivePanesListBoxHeader { get; set; }

ActivePanesListBoxStyle

Style

Gets or sets the Style for the active panes ListBox.

C#
public Style ActivePanesListBoxStyle { get; set; }

DescriptionStringFormat

Gets or sets the string format of the description presenter.

C#
public string DescriptionStringFormat { get; set; }

DescriptionTemplate

DataTemplate

Gets or sets the content template of the description presenter.

C#
public DataTemplate DescriptionTemplate { get; set; }

DescriptionTemplateSelector

DataTemplateSelector

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

C#
public DataTemplateSelector DescriptionTemplateSelector { get; set; }

FooterStringFormat

Gets or sets the string format of the footer presenter.

C#
public string FooterStringFormat { get; set; }

FooterTemplate

DataTemplate

Gets or sets the content template of the footer presenter.

C#
public DataTemplate FooterTemplate { get; set; }

FooterTemplateSelector

DataTemplateSelector

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

C#
public DataTemplateSelector FooterTemplateSelector { get; set; }

HeaderStringFormat

Gets or sets the string format of the header presenter.

C#
public string HeaderStringFormat { get; set; }

HeaderTemplate

DataTemplate

Gets or sets the content template of the header presenter.

C#
public DataTemplate HeaderTemplate { get; set; }

HeaderTemplateSelector

DataTemplateSelector

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

C#
public DataTemplateSelector HeaderTemplateSelector { get; set; }

IconTemplate

DataTemplate

Gets or sets the content template of the icon presenter.

C#
public DataTemplate IconTemplate { get; set; }

IconTemplateSelector

DataTemplateSelector

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

C#
public DataTemplateSelector IconTemplateSelector { get; set; }

ItemTemplateSelector

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

C#
public DockingNavigatorItemTemplateSelector ItemTemplateSelector { get; set; }

PreviewHeader

Gets or sets the header of the preview image.

C#
public string PreviewHeader { get; set; }

PreviewHeight

Gets or sets the height of the preview image.

C#
public double PreviewHeight { get; set; }

PreviewWidth

Gets or sets the width of the preview image.

C#
public double PreviewWidth { get; set; }

SelectDocumentPaneOnLoad

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

C#
protected bool SelectDocumentPaneOnLoad { get; set; }

Methods

GetDescription(DependencyObject)

Gets the Description of the pane used in DockingNavigator.

C#
public static object GetDescription(DependencyObject obj)
Parameters:objDependencyObjectReturns:

object

GetFooter(DependencyObject)

Gets the Footer of the pane used in DockingNavigator.

C#
public static object GetFooter(DependencyObject obj)
Parameters:objDependencyObjectReturns:

object

GetHeader(DependencyObject)

Gets the Header of the pane used in DockingNavigator.

C#
public static object GetHeader(DependencyObject obj)
Parameters:objDependencyObjectReturns:

object

GetIcon(DependencyObject)

Gets the Icon of the pane used in DockingNavigator.

C#
public static object GetIcon(DependencyObject obj)
Parameters:objDependencyObjectReturns:

object

Initialize()

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

C#
protected virtual bool Initialize()
Returns:

bool

OnApplyTemplate()

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

C#
public override void OnApplyTemplate()

OnClosed()

Called when the popup is closed.

C#
protected virtual void OnClosed()

OnCreateAutomationPeer()

AutomationPeer

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

OnInitialized(EventArgs)

Raises the event and sets from the active theme.

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The 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.

C#
protected override void OnKeyUp(KeyEventArgs e)
Parameters:eKeyEventArgs

OnOpening(NavigatorOpeningEventArgs)

Called before the popup is opened.

C#
protected virtual void OnOpening(NavigatorOpeningEventArgs args)
Parameters:argsNavigatorOpeningEventArgs

OnUpdatePreview()

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

C#
protected virtual void OnUpdatePreview()

SetDescription(DependencyObject, object)

Sets the Description of the pane used in DockingNavigator.

C#
public static void SetDescription(DependencyObject obj, object value)
Parameters:objDependencyObjectvalueobject

SetFooter(DependencyObject, object)

Sets the Footer of the pane used in DockingNavigator.

C#
public static void SetFooter(DependencyObject obj, object value)
Parameters:objDependencyObjectvalueobject

SetHeader(DependencyObject, object)

Sets the Header of the pane used in DockingNavigator.

C#
public static void SetHeader(DependencyObject obj, object value)
Parameters:objDependencyObjectvalueobject

SetIcon(DependencyObject, object)

Sets the Icon of the pane used in DockingNavigator.

C#
public static void SetIcon(DependencyObject obj, object value)
Parameters:objDependencyObjectvalueobject

ShouldOpen(KeyEventArgs)

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

C#
protected virtual bool ShouldOpen(KeyEventArgs args)
Parameters:argsKeyEventArgs

Keyboard event args.

Returns:

bool

True if the navigator should be opened.

Events

Closed

Occurs when docking navigator is closed.

C#
public event EventHandler<NavigatorClosedEventArgs> Closed

Opening

Occurs when docking navigator is about to open.

C#
public event EventHandler<NavigatorOpeningEventArgs> Opening
In this article
DefinitionConstructorsDockingNavigator()FieldsActiveDocumentsListBoxHeaderPropertyActiveDocumentsListBoxStylePropertyActivePanesListBoxHeaderPropertyActivePanesListBoxStylePropertyDescriptionPropertyDescriptionStringFormatPropertyDescriptionTemplatePropertyDescriptionTemplateSelectorPropertyFooterPropertyFooterStringFormatPropertyFooterTemplatePropertyFooterTemplateSelectorPropertyHeaderPropertyHeaderStringFormatPropertyHeaderTemplatePropertyHeaderTemplateSelectorPropertyIconPropertyIconTemplatePropertyIconTemplateSelectorPropertyItemTemplateSelectorPropertyPreviewHeaderPropertyPreviewHeightPropertyPreviewWidthPropertyPropertiesActiveDocumentsListBoxHeaderActiveDocumentsListBoxStyleActivePanesListBoxHeaderActivePanesListBoxStyleDescriptionStringFormatDescriptionTemplateDescriptionTemplateSelectorFooterStringFormatFooterTemplateFooterTemplateSelectorHeaderStringFormatHeaderTemplateHeaderTemplateSelectorIconTemplateIconTemplateSelectorItemTemplateSelectorPreviewHeaderPreviewHeightPreviewWidthSelectDocumentPaneOnLoadMethodsGetDescription(DependencyObject)GetFooter(DependencyObject)GetHeader(DependencyObject)GetIcon(DependencyObject)Initialize()OnApplyTemplate()OnClosed()OnCreateAutomationPeer()OnInitialized(EventArgs)OnKeyUp(KeyEventArgs)OnOpening(NavigatorOpeningEventArgs)OnUpdatePreview()SetDescription(DependencyObject, object)SetFooter(DependencyObject, object)SetHeader(DependencyObject, object)SetIcon(DependencyObject, object)ShouldOpen(KeyEventArgs)EventsClosedOpening
Not finding the help you need?
Contact Support