Skip to main content

BaseView.UseDocumentSelector Property

Gets or sets if a Document Selector is enabled for the current Document Manager.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

[DefaultValue(DefaultBoolean.Default)]
public virtual DefaultBoolean UseDocumentSelector { get; set; }

Property Value

Type Default Description
DefaultBoolean Default

A DefaultBoolean value specifying if a Document Selector is enabled for the current Document Manager

Available values:

Name Description Return Value
True

The value is true.

0

False

The value is false.

1

Default

The value is specified by a global option or a higher-level object.

2

Remarks

Forms within the DocumentManager can be presented in either the NativeMdiView or the TabbedView. For both these options, the Document Selector can be used. Invoked via the CTRL+TAB or CTRL+SHIFT+TAB shortcut, it allows you to switch to a specific document or dock panel (much like Microsoft Visual Studio). The following figure illustrates what the Document Selector looks like:

Document Manager Document Selector

Users can press the TAB and Arrow keys to navigate within the Document Selector. A small preview of the currently focused item is displayed for ease of navigation. When an end-user displays/hides a document selector, the BaseView.DocumentSelectorShown and BaseView.DocumentSelectorHidden events are fired. You can also check if a document selector is currently displayed via the BaseView.IsDocumentSelectorVisible property.

The default UseDocumentSelector value works the same as true, enabling the Document Selector.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the UseDocumentSelector property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also