DocumentManager.DocumentActivationScope Property

Gets or sets which Documents a Document Selector will display.

Namespace: DevExpress.XtraBars.Docking2010

Assembly: DevExpress.XtraBars.v20.1.dll

Declaration

[DefaultValue(DocumentActivationScope.Default)]
[DXCategory("Behavior")]
public DocumentActivationScope DocumentActivationScope { get; set; }
<DefaultValue(DocumentActivationScope.Default)>
<DXCategory("Behavior")>
Public Property DocumentActivationScope As DocumentActivationScope

Property Value

Type Default Description
DevExpress.XtraBars.Docking2010.Views.DocumentActivationScope

Default

A DocumentActivationScope enumerator value that specifies which Documents a Document Selector will display.

Remarks

Depending on the DocumentActivationScope property value, a Document Selector, when invoked. will display either all Documents within the View, or only Documents within the currently selected floating container (see the BaseView.FloatingDocumentContainer property). In the figure below, the main application form is selected, so the Document Selector displays only 'Document 1' and 'Document 2'.

DocumentManager - Scope 1

The second image illustrates the Document Selector when the Floating Document Container is active. As you can see, only 'Document 3' is available.

DocumentManager - Scope 2

This behavior applies to a DocumentManager, whose DocumentActivationScope property is set to DocumentsHost. If the DocumentActivationScope property equals AllDocuments (or Default), the Document Selector will display all Documents despite the currently selected element.

See Also