DocumentManager Members

The component that allows you to implement tabbed, native MDI, Windows 10-inspired or Widget application UIs.

Constructors

Name Description
DocumentManager() Initializes a new instance of the DocumentManager class.
DocumentManager(IContainer) Initializes a new instance of the DocumentManager class with the specified container.

Properties

Name Description
BarAndDockingController Gets or sets the BarAndDockingController that will provide default appearance options for the DocumentManager's elements.
Bounds Gets the bounding rectangle of the area occupied by the DocumentManager.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
ClientControl Gets or sets a client control to the current DocumentManager, switching it to the Non-Document Mode.
Container Gets the IContainer that contains the Component. Inherited from Component.
ContainerControl Gets or sets a control that contains the current DocumentManager within.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DockManager Gets a DockManager that belongs to the same container as the current DocumentManager.
DocumentActivationScope Gets or sets which Documents a Document Selector will display.
EnableThumbnailRenderingOnShowing static Gets or sets whether thumbnails for documents are generated right before these thumbnails are displayed.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
Images Provides access to the collection of images that can be associated with documents.
IsDisposing Gets whether the BaseComponent object is currently being disposed of. Inherited from BaseComponent.
IsDocumentSelectorVisible Gets if a document selector for this DocumentManager is currently visible.
IsInitialized Indicates whether or not the BaseComponent object has been fully initialized. Inherited from BaseComponent.
IsInitializing Returns whether or not the BaseComponent object is currently being initialized. Inherited from BaseComponent.
IsUpdateLocked Returns whether or not this BaseComponent is currently locked, which prevents any visual updates. Inherited from BaseComponent.
MaxThumbnailCount Gets or sets the maximum number of Document thumbnails within the Windows Task Bar for this DocumentManager.
MdiParent Gets or sets the parent MDI form.
MenuManager Gets or sets an object that controls the look and feel of the DocumentManager's popup menus.
RecreateMdiChildHandle static This member supports the internal infrastructure, and is not intended to be used directly from your code.
RibbonAndBarsMergeStyle Gets or sets whether Bar Managers and Ribbon Controls from this DocumentManager's child Documents should be automatically merged to Bars and Ribbons in the main application form.
RightToLeftLayout Gets or sets whether right-to-left mirror placement is turned on.
ShowThumbnailsInTaskBar Gets or sets whether thumbnails for the Documents within this DocumentManager should be displayed in Windows Task Bar.
ShowToolTips Gets or sets whether a tooltip should be displayed when the mouse pointer is over Document headers.
Site Gets or sets the ISite of the Component. Inherited from Component.
SnapMode Gets or sets whether or not Documents owned by this DocumentManager can stick to each other, parent forms or screen edges.
ToolTipController Gets or sets the tooltip controller component that controls the appearance, position and content of hints displayed for the current DocumentManager.
View Gets or sets a View object that displays child forms(or controls) in a specific manner.
ViewCollection Provides access to a collection of BaseView descendants that can be used within the DocumentManager.

Methods

Name Description
About() static Activates the DocumentManager's About dialog box.
BeginUpdate() Locks the BaseComponent, preventing visual updates of the object and its elements until the EndUpdate or CancelUpdate method is called. Inherited from BaseComponent.
CalcHitInfo(Point) Returns information on an object located at the specified position.
CancelUpdate() Unlocks the BaseComponent object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from BaseComponent.
ClientToScreen(Point) Converts client coordinates to screen coordinates.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
CreateView(ViewType) Creates a BaseView object for the current DocumentManager.
Dispose() Releases all resources used by the Component. Inherited from Component.
EndUpdate() Unlocks the BaseComponent object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from BaseComponent.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
ForceInitialize() Forces the control to finish its initialization.
FromContainer(IContainer, Control) static Gets a DocumentManager hosted within the specific container and control.
FromControl(Control) static Gets a DocumentManager hosted within the specific control.
FromCurrentControl(Control, Boolean, Boolean) static Retrieves a DocumentManager component from the target control.
GetDocument(Control) Returns a document that displays the specified control/dock panel/form.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType() Gets the Type of the current instance. Inherited from Object.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
Invalidate() Invalidates the region occupied by the DocumentManager (adds it to the update region that will be repainted during the next paint operation), and causes a paint message to be sent to the DocumentManager.
Invalidate(Rectangle) Invalidates the specified region occupied by the DocumentManager (adds it to the update region that will be repainted during the next paint operation), and causes a paint message to be sent to the DocumentManager.
IsReadyToPerformUIOperations() This member supports the internal infrastructure, and is not intended to be used directly from your code.
LayoutChanged() Updates the element. Inherited from BaseComponent.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
ReplaceOwnerForm() Call this method to change the DocumentManager parent form.
ScreenToClient(Point) Converts the screen coordinates of a specified point on the screen to client-area coordinates.
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.
Update() Invalidates the region occupied by the current DocumentManager.

Events

Name Description
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DocumentActivate Occurs whenever a Document within this DocumentManager is activated.
ViewChanged Occurs after the DocumentManager has switched to another view.
ViewChanging Occurs when the current DocumentManager changes its active view and allows you to respond to these changes before they are applied.
See Also