Class
QuickNavigatorSettings

Encapsulates all the settings that control the appearance and behavior of the QuickNavigator for a RadDock.

Definition

Namespace:Telerik.WinControls.UI.Docking

Assembly:Telerik.WinControls.RadDock.dll

Syntax:

cs-api-definition
[TypeConverter(typeof(ExpandableObjectConverter))]
public class QuickNavigatorSettings : RadDockObject, IDisposable, INotifyPropertyChanged, INotifyPropertyChangingEx

Inheritance: objectRadDockObjectQuickNavigatorSettings

Implements: IDisposableINotifyPropertyChangedINotifyPropertyChangingEx

Inherited Members RadDockObject.Dispose()RadDockObject.Dispose(bool)RadDockObject.DisposeManagedResources()RadDockObject.DisposeUnmanagedResources()RadDockObject.OnPropertyChanging(string)RadDockObject.OnPropertyChanged(string)RadDockObject.ShouldSerializeProperty(string)RadDockObject.EventsRadDockObject.DisposingRadDockObject.IsDisposedRadDockObject.DisposedRadDockObject.PropertyChangingRadDockObject.PropertyChanged

Constructors

QuickNavigatorSettings()

Default constructor.

Declaration

cs-api-definition
public QuickNavigatorSettings()

Properties

ColumnSpacing

Gets or sets the spacing between columns in panes lists.

Declaration

cs-api-definition
public int ColumnSpacing { get; set; }

Property Value

int

DisplayPosition

Determines the display position of the QuickNavigator.

Declaration

cs-api-definition
public QuickNavigatorDisplayPosition DisplayPosition { get; set; }

Property Value

QuickNavigatorDisplayPosition

DocumentPaneColumns

Determines the number of columns in the DocumentWindow list. Defaults to zero which specifies that the number of columns is automatically calculated.

Declaration

cs-api-definition
public int DocumentPaneColumns { get; set; }

Property Value

int

DocumentPaneListHeader

Gets or sets the text for the header of the DocumentWindow list.

Declaration

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

Property Value

string

DropShadow

Determines whether the Form that hosts the QuickNavigator will drop shadow or not.

Declaration

cs-api-definition
public bool DropShadow { get; set; }

Property Value

bool

Enabled

Determines whether the navigator is enabled (displayed when the shortcut combination is triggered).

Declaration

cs-api-definition
public bool Enabled { get; set; }

Property Value

bool

FooterPadding

Gets or sets the padding to be applied on the footer part of the navigator.

Declaration

cs-api-definition
public Padding FooterPadding { get; set; }

Property Value

Padding

ForceSnapshot

Gets or sets a value indicating whether the QuickNavigator will try to update the selected DockWindow's bounds, so that a preview snapshot may be taken.

Declaration

cs-api-definition
public bool ForceSnapshot { get; set; }

Property Value

bool

HeaderPadding

Gets or sets the padding to be applied on the header part of the navigator.

Declaration

cs-api-definition
public Padding HeaderPadding { get; set; }

Property Value

Padding

ItemsPerColumn

Gets or sets the number of items per column in the dock pane lists.

Declaration

cs-api-definition
public int ItemsPerColumn { get; set; }

Property Value

int

ListItemSize

Gets or sets the size of a single item in the pane lists.

Declaration

cs-api-definition
public Size ListItemSize { get; set; }

Property Value

Size

ListItemType

Gets or sets the Type used to create items in the QuickNavigator's lists. This should be a valid QuickNavigatorListItem assignable type.

Declaration

cs-api-definition
[Browsable(false)]
public Type ListItemType { get; set; }

Property Value

Type

MaxSize

Gets or sets the maximum size the navigator will occupy on the screen. Defaults to the screen bounds and will always be truncated to that value if the provided custom size exceeds screen's bounds.

Declaration

cs-api-definition
public Size MaxSize { get; set; }

Property Value

Size

PreviewSize

Gets or sets the minimum size of the Preview element.

Declaration

cs-api-definition
public Size PreviewSize { get; set; }

Property Value

Size

ShowDocumentPanes

Determines whether the DocumentWindow list is visible.

Declaration

cs-api-definition
public bool ShowDocumentPanes { get; set; }

Property Value

bool

ShowFooter

Determines whether the footer area of the QuickNavigator is visible.

Declaration

cs-api-definition
public bool ShowFooter { get; set; }

Property Value

bool

ShowHeader

Determines whether the header area of the QuickNavigator is visible.

Declaration

cs-api-definition
public bool ShowHeader { get; set; }

Property Value

bool

ShowPreview

Determines whether the Preview element is visible. The Preview displays a snapshot of the selected DockWindow in either of the QuickNavigator's lists.

Declaration

cs-api-definition
public bool ShowPreview { get; set; }

Property Value

bool

ShowToolPanes

Determines whether the ToolWindow list is visible.

Declaration

cs-api-definition
public bool ShowToolPanes { get; set; }

Property Value

bool

ToolPaneColumns

Determines the number of columns in the ToolWindow list. Defaults to zero which specifies that the number of columns is automatically calculated.

Declaration

cs-api-definition
public int ToolPaneColumns { get; set; }

Property Value

int

ToolPaneListHeader

Gets or sets the text for the header of the ToolWindow list.

Declaration

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

Property Value

string