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.
Definition
Namespace:Telerik.WinControls.UI.Docking
Assembly:Telerik.WinControls.RadDock.dll
Syntax:
[TypeConverter(typeof(ExpandableObjectConverter))]
public class DocumentManager : RadDockObject, IDisposable, INotifyPropertyChanged, INotifyPropertyChangingEx
Inheritance: objectRadDockObjectDocumentManager
Implements:
Inherited Members
Properties
Gets the currently active document in the owning RadDock instance.
[Browsable(false)]
public DockWindow ActiveDocument { get; }
Gets or sets the ActiveDocumentListSortOrder value, which defines how menu items will be sorted in the active document list menu.
public ActiveDocumentListSortOrder ActiveDocumentMenuSortOrder { get; set; }
Determines whether the currently active document's Text will be displayed in bold Font in its corresponding TabItem.
public bool BoldActiveDocument { get; set; }
Gets an array of DockWindow instances, which DockState equals to DockState.TabbedDocument, in the order they appear in their parent strips.
[Browsable(false)]
public DockWindow[] DocumentArray { get; }
Gets an array of DockWindow instances, which DockState equals TabbedDocument. The array is sorted by the Text value of each document.
[Browsable(false)]
public DockWindow[] DocumentArraySortedByText { get; }
Gets an array of DockWindow instances, which DockState equals to DockState.TabbedDocument. The array is sorted by each window's z-order.
[Browsable(false)]
public DockWindow[] DocumentArrayZOrdered { get; }
Determines which document should become active when the current active one is closed.
public DocumentCloseActivation DocumentCloseActivation { get; set; }
DocumentEnumerator
IEnumerable<DockWindow>
Gest an enumerator, which allows for iterating all registered documents in the order they appear in their parent strips.
[Browsable(false)]
public IEnumerable<DockWindow> DocumentEnumerator { get; }
DocumentEnumeratorSortedByText
IEnumerable<DockWindow>
Gets an enumerator, which allows for iterating all registered documents in a sorted-by-text manner.
[Browsable(false)]
public IEnumerable<DockWindow> DocumentEnumeratorSortedByText { get; }
DocumentEnumeratorZOrdered
IEnumerable<DockWindow>
Gets an enumerator, which allows for iterating all registered documents in their z-order.
[Browsable(false)]
public IEnumerable<DockWindow> DocumentEnumeratorZOrdered { get; }
Gets or sets the insert order to be used when adding new documents.
public DockWindowInsertOrder DocumentInsertOrder { get; set; }
Methods
Activates the next document in the z-ordered list.
public void ActivateNextDocument()
Activates the previous document in the z-ordered list.
public void ActivatePreviousDocument()
Disposes any managed resources associated with this object.
protected override void DisposeManagedResources()
Overrides:
Gets the list of menu items to be displayed on the ActiveWindowList on the specified DocumentTabStrip.
public IEnumerable<DockWindow> GetActiveWindowList(DocumentTabStrip strip)
IEnumerable<DockWindow>
The manager gets notified that the owning RadDock instance has been sucessfully loaded.
protected void OnDockManagerLoaded()