Class DocumentManager

Manages the document windows in a RadDock instance. Supports additional collection of all DockWindow instances that reside within a DocumentTabStrip. The collection's sort order depends on the activation precedence. Provides methods for navigating to next and previous document. Keeps track of the currently active window.

Inheritance
System.Object
RadDockObject
DocumentManager
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI.Docking
Assembly: Telerik.WinControls.RadDock.dll

Syntax

public class DocumentManager : RadDockObject, IDisposable, INotifyPropertyChanged, INotifyPropertyChangingEx

Properties

ActiveDocument

Gets the currently active document in the owning RadDock instance.

Declaration
public DockWindow ActiveDocument { get; }
Property Value
DockWindow

ActiveDocumentMenuSortOrder

Gets or sets the ActiveDocumentListSortOrder value, which defines how menu items will be sorted in the active document list menu.

Declaration
public ActiveDocumentListSortOrder ActiveDocumentMenuSortOrder { get; set; }
Property Value
ActiveDocumentListSortOrder

BoldActiveDocument

Determines whether the currently active document's Text will be displayed in bold Font in its corresponding TabItem.

Declaration
public bool BoldActiveDocument { get; set; }
Property Value
System.Boolean

DocumentArray

Gets an array of DockWindow instances, which DockState equals to DockState.TabbedDocument, in the order they appear in their parent strips.

Declaration
public DockWindow[] DocumentArray { get; }
Property Value
DockWindow[]

DocumentArraySortedByText

Gets an array of DockWindow instances, which DockState equals TabbedDocument. The array is sorted by the Text value of each document.

Declaration
public DockWindow[] DocumentArraySortedByText { get; }
Property Value
DockWindow[]

DocumentArrayZOrdered

Gets an array of DockWindow instances, which DockState equals to DockState.TabbedDocument. The array is sorted by each window's z-order.

Declaration
public DockWindow[] DocumentArrayZOrdered { get; }
Property Value
DockWindow[]

DocumentCloseActivation

Determines which document should become active when the current active one is closed.

Declaration
public DocumentCloseActivation DocumentCloseActivation { get; set; }
Property Value
DocumentCloseActivation

DocumentEnumerator

Gest an enumerator, which allows for iterating all registered documents in the order they appear in their parent strips.

Declaration
public IEnumerable<DockWindow> DocumentEnumerator { get; }
Property Value
System.Collections.Generic.IEnumerable<DockWindow>

DocumentEnumeratorSortedByText

Gets an enumerator, which allows for iterating all registered documents in a sorted-by-text manner.

Declaration
public IEnumerable<DockWindow> DocumentEnumeratorSortedByText { get; }
Property Value
System.Collections.Generic.IEnumerable<DockWindow>

DocumentEnumeratorZOrdered

Gets an enumerator, which allows for iterating all registered documents in their z-order.

Declaration
public IEnumerable<DockWindow> DocumentEnumeratorZOrdered { get; }
Property Value
System.Collections.Generic.IEnumerable<DockWindow>

DocumentInsertOrder

Gets or sets the insert order to be used when adding new documents.

Declaration
public DockWindowInsertOrder DocumentInsertOrder { get; set; }
Property Value
DockWindowInsertOrder

Methods

ActivateNextDocument()

Activates the next document in the z-ordered list.

Declaration
public void ActivateNextDocument()

ActivatePreviousDocument()

Activates the previous document in the z-ordered list.

Declaration
public void ActivatePreviousDocument()

DisposeManagedResources()

Declaration
protected override void DisposeManagedResources()
Overrides

GetActiveWindowList(DocumentTabStrip)

Gets the list of menu items to be displayed on the ActiveWindowList on the specified DocumentTabStrip.

Declaration
public IEnumerable<DockWindow> GetActiveWindowList(DocumentTabStrip strip)
Parameters
DocumentTabStrip strip

Returns
System.Collections.Generic.IEnumerable<DockWindow>

OnDockManagerLoaded()

The manager gets notified that the owning RadDock instance has been sucessfully loaded.

Declaration
protected void OnDockManagerLoaded()

Extension Methods