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.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Navigation

Declaration

C#

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

VB.NET

<DefaultValue(DefaultBoolean.Default)>
Public Overridable Property UseDocumentSelector As DefaultBoolean

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
True	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

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:

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.

Related GitHub Examples

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.

C#

winforms-tabbed-ui-control-based-document/CS/DcoumentManagerContentGenerator/Form1.cs#L21

documentManager2.View.DocumentProperties.UseFormIconAsDocumentImage = false;
documentManager2.View.UseDocumentSelector = DevExpress.Utils.DefaultBoolean.True;
tabbedView1.FloatingDocumentContainer = FloatingDocumentContainer.DocumentsHost;

VB.NET

winforms-tabbed-ui-control-based-document/VB/DcoumentManagerContentGenerator/Form1.vb#L23

documentManager2.View.DocumentProperties.UseFormIconAsDocumentImage = False
documentManager2.View.UseDocumentSelector = DevExpress.Utils.DefaultBoolean.True
tabbedView1.FloatingDocumentContainer = FloatingDocumentContainer.DocumentsHost