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.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Docking.dll

Syntax:

cs-api-definition
public class DockingNavigator : Control

Inheritance: objectDockingNavigator

Constructors

DockingNavigator()

Declaration

cs-api-definition
public DockingNavigator()

Fields

ActiveDocumentsListBoxHeaderProperty

Identifies the ActiveDocumentsListBoxHeader dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ActiveDocumentsListBoxHeaderProperty

Field Value

DependencyProperty

ActiveDocumentsListBoxStyleProperty

Identifies the ActiveDocumentsListBoxStyle dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ActiveDocumentsListBoxStyleProperty

Field Value

DependencyProperty

ActivePanesListBoxHeaderProperty

Identifies the ActivePanesListBoxHeader dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ActivePanesListBoxHeaderProperty

Field Value

DependencyProperty

ActivePanesListBoxStyleProperty

Identifies the ActivePanesListBoxStyle dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ActivePanesListBoxStyleProperty

Field Value

DependencyProperty

DescriptionProperty

Identifies the Description attached property of the DockingNavigator.

Declaration

cs-api-definition
public static readonly DependencyProperty DescriptionProperty

Field Value

DependencyProperty

DescriptionStringFormatProperty

Identifies the DescriptionStringFormat dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty DescriptionStringFormatProperty

Field Value

DependencyProperty

DescriptionTemplateProperty

Identifies the DescriptionTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty DescriptionTemplateProperty

Field Value

DependencyProperty

DescriptionTemplateSelectorProperty

Identifies the DescriptionTemplateSelector dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty DescriptionTemplateSelectorProperty

Field Value

DependencyProperty

FooterProperty

Identifies the Footer attached property of the DockingNavigator.

Declaration

cs-api-definition
public static readonly DependencyProperty FooterProperty

Field Value

DependencyProperty

FooterStringFormatProperty

Identifies the FooterStringFormat dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty FooterStringFormatProperty

Field Value

DependencyProperty

FooterTemplateProperty

Identifies the FooterTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty FooterTemplateProperty

Field Value

DependencyProperty

FooterTemplateSelectorProperty

Identifies the FooterTemplateSelector dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty FooterTemplateSelectorProperty

Field Value

DependencyProperty

HeaderProperty

Identifies the Header attached property of the DockingNavigator.

Declaration

cs-api-definition
public static readonly DependencyProperty HeaderProperty

Field Value

DependencyProperty

HeaderStringFormatProperty

Identifies the HeaderStringFormat dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty HeaderStringFormatProperty

Field Value

DependencyProperty

HeaderTemplateProperty

Identifies the HeaderTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty HeaderTemplateProperty

Field Value

DependencyProperty

HeaderTemplateSelectorProperty

Identifies the HeaderTemplateSelector dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty HeaderTemplateSelectorProperty

Field Value

DependencyProperty

IconProperty

Identifies the Icon attached property of the DockingNavigator.

Declaration

cs-api-definition
public static readonly DependencyProperty IconProperty

Field Value

DependencyProperty

IconTemplateProperty

Identifies the IconTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IconTemplateProperty

Field Value

DependencyProperty

IconTemplateSelectorProperty

Identifies the IconTemplateSelector dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IconTemplateSelectorProperty

Field Value

DependencyProperty

ItemTemplateSelectorProperty

Identifies the ItemTemplateSelector dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemTemplateSelectorProperty

Field Value

DependencyProperty

PreviewHeaderProperty

Identifies the PreviewHeader dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty PreviewHeaderProperty

Field Value

DependencyProperty

PreviewHeightProperty

Identifies the PreviewHeight dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty PreviewHeightProperty

Field Value

DependencyProperty

PreviewWidthProperty

Identifies the PreviewWidth dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty PreviewWidthProperty

Field Value

DependencyProperty

Properties

ActiveDocumentsListBoxHeader

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

Declaration

cs-api-definition
public string ActiveDocumentsListBoxHeader { get; set; }

Property Value

string

ActiveDocumentsListBoxStyle

Gets or sets the Style for the active documents ListBox.

Declaration

cs-api-definition
public Style ActiveDocumentsListBoxStyle { get; set; }

Property Value

Style

ActivePanesListBoxHeader

Gets or sets the header of the active panes ListBox.

Declaration

cs-api-definition
public string ActivePanesListBoxHeader { get; set; }

Property Value

string

ActivePanesListBoxStyle

Gets or sets the Style for the active panes ListBox.

Declaration

cs-api-definition
public Style ActivePanesListBoxStyle { get; set; }

Property Value

Style

DescriptionStringFormat

Gets or sets the string format of the description presenter.

Declaration

cs-api-definition
public string DescriptionStringFormat { get; set; }

Property Value

string

DescriptionTemplate

Gets or sets the content template of the description presenter.

Declaration

cs-api-definition
public DataTemplate DescriptionTemplate { get; set; }

Property Value

DataTemplate

DescriptionTemplateSelector

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

Declaration

cs-api-definition
public DataTemplateSelector DescriptionTemplateSelector { get; set; }

Property Value

DataTemplateSelector

FooterStringFormat

Gets or sets the string format of the footer presenter.

Declaration

cs-api-definition
public string FooterStringFormat { get; set; }

Property Value

string

FooterTemplate

Gets or sets the content template of the footer presenter.

Declaration

cs-api-definition
public DataTemplate FooterTemplate { get; set; }

Property Value

DataTemplate

FooterTemplateSelector

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

Declaration

cs-api-definition
public DataTemplateSelector FooterTemplateSelector { get; set; }

Property Value

DataTemplateSelector

HeaderStringFormat

Gets or sets the string format of the header presenter.

Declaration

cs-api-definition
public string HeaderStringFormat { get; set; }

Property Value

string

HeaderTemplate

Gets or sets the content template of the header presenter.

Declaration

cs-api-definition
public DataTemplate HeaderTemplate { get; set; }

Property Value

DataTemplate

HeaderTemplateSelector

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

Declaration

cs-api-definition
public DataTemplateSelector HeaderTemplateSelector { get; set; }

Property Value

DataTemplateSelector

IconTemplate

Gets or sets the content template of the icon presenter.

Declaration

cs-api-definition
public DataTemplate IconTemplate { get; set; }

Property Value

DataTemplate

IconTemplateSelector

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

Declaration

cs-api-definition
public DataTemplateSelector IconTemplateSelector { get; set; }

Property Value

DataTemplateSelector

ItemTemplateSelector

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

Declaration

cs-api-definition
public DockingNavigatorItemTemplateSelector ItemTemplateSelector { get; set; }

Property Value

DockingNavigatorItemTemplateSelector

PreviewHeader

Gets or sets the header of the preview image.

Declaration

cs-api-definition
public string PreviewHeader { get; set; }

Property Value

string

PreviewHeight

Gets or sets the height of the preview image.

Declaration

cs-api-definition
public double PreviewHeight { get; set; }

Property Value

double

PreviewWidth

Gets or sets the width of the preview image.

Declaration

cs-api-definition
public double PreviewWidth { get; set; }

Property Value

double

SelectDocumentPaneOnLoad

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

Declaration

cs-api-definition
protected bool SelectDocumentPaneOnLoad { get; set; }

Property Value

bool

Methods

GetDescription(DependencyObject)

Gets the Description of the pane used in DockingNavigator.

Declaration

cs-api-definition
public static object GetDescription(DependencyObject obj)

Parameters

obj

DependencyObject

Returns

object

GetFooter(DependencyObject)

Gets the Footer of the pane used in DockingNavigator.

Declaration

cs-api-definition
public static object GetFooter(DependencyObject obj)

Parameters

obj

DependencyObject

Returns

object

GetHeader(DependencyObject)

Gets the Header of the pane used in DockingNavigator.

Declaration

cs-api-definition
public static object GetHeader(DependencyObject obj)

Parameters

obj

DependencyObject

Returns

object

GetIcon(DependencyObject)

Gets the Icon of the pane used in DockingNavigator.

Declaration

cs-api-definition
public static object GetIcon(DependencyObject obj)

Parameters

obj

DependencyObject

Returns

object

Initialize()

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

Declaration

cs-api-definition
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 .

Declaration

cs-api-definition
public override void OnApplyTemplate()

OnClosed()

Called when the popup is closed.

Declaration

cs-api-definition
protected virtual void OnClosed()

OnCreateAutomationPeer()

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

OnInitialized(EventArgs)

Raises the event and sets from the active theme.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

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.

Declaration

cs-api-definition
protected override void OnKeyUp(KeyEventArgs e)

Parameters

e

KeyEventArgs

OnOpening(NavigatorOpeningEventArgs)

Called before the popup is opened.

Declaration

cs-api-definition
protected virtual void OnOpening(NavigatorOpeningEventArgs args)

Parameters

args

NavigatorOpeningEventArgs

OnUpdatePreview()

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

Declaration

cs-api-definition
protected virtual void OnUpdatePreview()

SetDescription(DependencyObject, object)

Sets the Description of the pane used in DockingNavigator.

Declaration

cs-api-definition
public static void SetDescription(DependencyObject obj, object value)

Parameters

obj

DependencyObject

value

object

SetFooter(DependencyObject, object)

Sets the Footer of the pane used in DockingNavigator.

Declaration

cs-api-definition
public static void SetFooter(DependencyObject obj, object value)

Parameters

obj

DependencyObject

value

object

SetHeader(DependencyObject, object)

Sets the Header of the pane used in DockingNavigator.

Declaration

cs-api-definition
public static void SetHeader(DependencyObject obj, object value)

Parameters

obj

DependencyObject

value

object

SetIcon(DependencyObject, object)

Sets the Icon of the pane used in DockingNavigator.

Declaration

cs-api-definition
public static void SetIcon(DependencyObject obj, object value)

Parameters

obj

DependencyObject

value

object

ShouldOpen(KeyEventArgs)

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

Declaration

cs-api-definition
protected virtual bool ShouldOpen(KeyEventArgs args)

Parameters

args

KeyEventArgs

Keyboard event args.

Returns

bool

True if the navigator should be opened.

Events

Closed

Occurs when docking navigator is closed.

Declaration

cs-api-definition
public event EventHandler<NavigatorClosedEventArgs> Closed

Event Value

EventHandler<NavigatorClosedEventArgs>

Opening

Occurs when docking navigator is about to open.

Declaration

cs-api-definition
public event EventHandler<NavigatorOpeningEventArgs> Opening

Event Value

EventHandler<NavigatorOpeningEventArgs>

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