ClassDocumentManager
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, INotifyPropertyChangingExInheritance: objectRadDockObjectDocumentManager
Implements:
Inherited Members
Properties
ActiveDocument
Gets the currently active document in the owning RadDock instance.
Declaration
[Browsable(false)]
public DockWindow ActiveDocument { get; }Property Value
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
BoldActiveDocument
Determines whether the currently active document's Text will be displayed in bold Font in its corresponding TabItem.
DocumentArray
Gets an array of DockWindow instances, which DockState equals to DockState.TabbedDocument, in the order they appear in their parent strips.
Declaration
[Browsable(false)]
public DockWindow[] DocumentArray { get; }Property Value
DocumentArraySortedByText
Gets an array of DockWindow instances, which DockState equals TabbedDocument. The array is sorted by the Text value of each document.
Declaration
[Browsable(false)]
public DockWindow[] DocumentArraySortedByText { get; }Property Value
DocumentArrayZOrdered
Gets an array of DockWindow instances, which DockState equals to DockState.TabbedDocument. The array is sorted by each window's z-order.
Declaration
[Browsable(false)]
public DockWindow[] DocumentArrayZOrdered { get; }Property Value
DocumentCloseActivation
Determines which document should become active when the current active one is closed.
Declaration
public DocumentCloseActivation DocumentCloseActivation { get; set; }Property Value
DocumentEnumerator
Gest an enumerator, which allows for iterating all registered documents in the order they appear in their parent strips.
Declaration
[Browsable(false)]
public IEnumerable<DockWindow> DocumentEnumerator { get; }Property Value
DocumentEnumeratorSortedByText
Gets an enumerator, which allows for iterating all registered documents in a sorted-by-text manner.
Declaration
[Browsable(false)]
public IEnumerable<DockWindow> DocumentEnumeratorSortedByText { get; }Property Value
DocumentEnumeratorZOrdered
Gets an enumerator, which allows for iterating all registered documents in their z-order.
Declaration
[Browsable(false)]
public IEnumerable<DockWindow> DocumentEnumeratorZOrdered { get; }Property Value
DocumentInsertOrder
Gets or sets the insert order to be used when adding new documents.
Declaration
public DockWindowInsertOrder DocumentInsertOrder { get; set; }Property Value
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()
Disposes any managed resources associated with this object.
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
strip
Returns
OnDockManagerLoaded()
The manager gets notified that the owning RadDock instance has been sucessfully loaded.
Declaration
protected void OnDockManagerLoaded()