BaseView Members
The base class for Views in a DocumentManager.Properties
| Name | Description |
|---|---|
| ActiveDocument | Gets the active document. |
| ActiveFloatDocument | Gets the active floating document. |
| AllowHotkeyNavigation | Gets or sets whether switching between tabbed documents using keyboard shortcuts is allowed. |
| AllowResetLayout | Gets or sets whether the current DocumentManager‘s layout can be reset to default. |
| Appearance | Contains appearance settings for the current View. |
| BackgroundImage | Gets or sets the current DocumentManager‘s background image. |
| BackgroundImageLayoutMode | Gets or sets the background image layout as defined in the ImageLayoutMode enumeration. |
| BackgroundImageStretchMargins | Gets or sets stretching margins for a DocumentManager‘s background image in a View. |
| Bounds | Gets the visual bounds of the current object. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| Controller | Provides methods to work with documents in the current View. |
| CustomResizeZoneThickness | Gets or sets the resize zone thickness. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| DocumentProperties | Provides access to properties common to all documents within the current View. |
| Documents | Stores all documents displayed within the View. |
| DocumentSelectorProperties | Provides access to appearance settings used for a Document Selector within the current view. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| FloatDocuments | Provides access to floating documents. |
| FloatDocumentsAlwaysOnTop | Gets or sets whether floating Documents are always drawn on top of their parent forms. |
| FloatingDocumentContainer | Gets or sets a type of container for floating documents within the current BaseView. |
| FloatPanels | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| IsDisposing | Gets whether the BaseComponent object is currently being disposed of. Inherited from BaseComponent. |
| IsDocumentSelectorVisible | Gets if a document selector for this BaseView is currently visible. |
| IsEmpty | Gets whether a View is empty. |
| IsFocused | Gets whether any document within the current View has focus. |
| 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. |
| IsLoaded | Gets whether the current object has been loaded. |
| IsLoading | Gets whether the current object is being loaded. |
| IsLoadingAnimationInProgress | Gets whether loading indicator animation is currently running within this View. |
| IsUpdateLocked | Returns whether or not this BaseComponent is currently locked, which prevents any visual updates. Inherited from BaseComponent. |
| Items | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| LoadingIndicatorProperties | Provides access to appearance settings used for a loading indicator within the current BaseView. |
| Manager | Gets a DocumentManager that owns the current View. |
| OptionsLayout | Gets the object containing properties related to the current View’s layout. |
| Padding | This is an internal property that should not be used. |
| Site | Gets or sets the ISite of the Component. Inherited from Component. |
| Style | Gets or sets the View style. |
| Type | Gets the current View’s type. |
| UseDocumentSelector | Gets or sets if a Document Selector is enabled for the current Document Manager. |
| UseLoadingIndicator | Gets or sets if a loading indicator for deferred load should be used. |
| UseSnappingEmulation | Gets or sets whether this BaseView uses snapping emulation for its child documents. |
| WindowsDialogProperties | Gets an object containing settings related to the current DocumentManager‘s Windows dialog. |
Methods
| Name | Description |
|---|---|
| ActivateDocument(Control) | Activates the document that displays the specified control. |
| AddDocument(String, String) | Adds an empty Document with specified BaseDocument.Caption and BaseDocument.ControlName properties to the current View. |
| AddDocument(Control, String) | Creates a Document that wraps the target control, and adds this new Document to the current BaseView. |
| AddFloatDocument(Control, Point, Size) | Creates a floating document that hosts the target control, has the required size, and is displayed in the given location. |
| AddFloatDocument(Control, Point) | Creates the floating document that hosts the target control and is displayed at the given position. |
| AddFloatDocument(Control, String) | Creates a floating document that hosts the target control. |
| AddFloatingDocumentsHost(BaseDocument) | Creates a documents host window that contains the specified document. This method is in effect in the DocumentsHost mode. |
| AddFloatingDocumentsHost(BaseDocument[]) | Creates a floating documents host (container) that will contain the specific BaseDocument objects collection. |
| AddFloatingDocumentsHost(Control) | Creates a documents host window that contains a newly created document wrapping the specified control. This method is in effect in the DocumentsHost mode. |
| AddOrActivateDocument(Predicate<BaseDocument>, Func<Control>) | Activates an existing document that contains the specific control. If no such document was found, a new document is created and added to this View. |
| BeginUpdate() | Locks the BaseComponent, preventing visual updates of the object and its elements until the EndUpdate or CancelUpdate method is called. Inherited from BaseComponent. |
| CancelUpdate() | Unlocks the BaseComponent object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from BaseComponent. |
| 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. |
| 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, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| 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. |
| 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. |
| ReleaseDeferredLoadControl(BaseDocument, Boolean, Boolean) | Fires the BaseView.ControlReleasing event with the specified parameters for the specified document. |
| ReleaseDeferredLoadControl(BaseDocument, Boolean) | Fires the BaseView.ControlReleasing event with the specified parameter for the specified document. |
| ReleaseDeferredLoadControl(BaseDocument) | Disposes a specific deferred load Document within the current View. |
| ReleaseDeferredLoadControls() | Disposes all deferred load Documents within the current view. |
| ReleaseDeferredLoadControls(Boolean, Boolean) | Fires the BaseView.ControlReleasing event with the specified parameters for all documents with unreleased content in the current BaseView. |
| ReleaseDeferredLoadControls(Boolean) | Fires the BaseView.ControlReleasing event with the specified parameter for all documents with unreleased content in the current BaseView. |
| RemoveDocument(Control) | Removes a document whose BaseDocument.Control property’s value matches the specified control object. |
| RestoreLayoutFromRegistry(String) | Restores the layout from a specific registry key. |
| RestoreLayoutFromStream(Stream, Boolean) | Restores the layout from a stream that contains data in a specific format. |
| RestoreLayoutFromStream(Stream) | Restores the layout from a stream that contains data in binary format. |
| RestoreLayoutFromXml(Stream) | Restores the layout from a specific stream that contains data in XML format. |
| RestoreLayoutFromXml(String) | Restores the layout from a specific XML file. |
| SaveLayoutToRegistry(String) | Saves the layout in the system registry. |
| SaveLayoutToStream(Stream, Boolean) | Saves the layout in a specific stream in binary format. |
| SaveLayoutToStream(Stream) | Saves the layout in a specific stream in binary format. |
| SaveLayoutToXml(Stream) | Saves the layout in a specific stream in XML format. |
| SaveLayoutToXml(String) | Saves the layout in a specific file in XML format. |
| ToString() | Gets the text representation of the BaseView object. |
Events
| Name | Description |
|---|---|
| BeforeLoadLayout | Fires when the View attempts to restore a previously saved layout version. Allows you to cancel this restoration. |
| BeginDocking | Allows you to cancel docking a document onto the current control. |
| BeginDocumentsHostDocking | Occurs whenever a Floating Documents Container starts docking to this BaseView. |
| BeginFloating | Fires when an end-user starts to drag a docked document, so that it is transformed into a floating window. |
| BeginSizing | Occurs when a resizing of the current View’s layout begins. |
| ControlLoaded | Occurs after a control has been loaded to a Document within this BaseView. |
| ControlReleased | Fires after a control has been succesfully unbound from its parent document. |
| ControlReleasing | Occurs when a document is deselected and allows you to unbind the document from its content and dispose of the content. This event is in effect in Deferred Load mode. |
| ControlShown | Fires when an empty document is loaded and displayed. |
| CustomDocumentsHostWindow | Allows you to replace the default container for floating documents. Handle this event only when the BaseView.FloatingDocumentContainer property equals DocumentsHost. |
| CustomDrawBackground | Occurs when the current View’s background becomes visible to an end-user. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| DocumentActivated | Fires when the View’s ActiveDocument or ActiveFloatDocument property value changes. This event does not occur on DocumentManager initialization, or when user focus switches between a docked and a floating Document. In these cases, handle the DocumentActivate event instead. |
| DocumentAdded | Fires when a new document is added to the current View. |
| DocumentClosed | Fires after a document has been closed. |
| DocumentClosing | Fires when a document is about to be closed. |
| DocumentDeactivated | Fires when a document is deactivated. |
| DocumentRemoved | Fires when a document is removed from the BaseView.Documents collection. |
| DocumentSelectorCustomSortItems | Allows you to manually sort documents and dock panels displayed within the Document Selector. |
| DocumentSelectorHidden | Fires when a document selector is closed. |
| DocumentSelectorShown | Fires when a document selector is displayed. |
| EmptyDocumentsHostWindow | Fires when the last floating document in the documents host window is closed or the control it contains is disposed, allowing you to specify whether to keep open the empty documents host window. |
| EndDocking | Fires after a document has been docked to the control. |
| EndDocumentsHostDocking | Occurs when a Floating Document Container with all its child Documents is docked to a View. |
| EndFloating | Fires after an end-user drops a floating document. |
| EndSizing | Occurs when resizing the current View’s layout is complete. |
| Floating | Fires when a docked document becomes floating. |
| GotFocus | Fires when focus is moved to any document within the current View. |
| Layout | Occurs whenever the current DocumentManager‘s layout is being modified. |
| LayoutReset | Fires after a DocumentManager‘s layout was reset. |
| LayoutResetting | Occurs when the current BaseView‘s layout is to be reset. |
| LayoutUpgrade | Occurs after a layout whose version doesn’t match the current layout’s version has been loaded from storage (a stream, xml file or system registry). |
| LoadingIndicatorShowing | Occurs when the loading indicator is shown within this BaseView. |
| LostFocus | Fires when focus is moved from the current View’s document to any external control (for instance, to an external DockPanel). |
| NextDocument | Fires when an end-user tries to switch to the next or previous document by pressing CTRL+TAB or CTRL+SHIFT+TAB. |
| Paint | Occurs when the BaseView is redrawn. |
| PopupMenuShowing | Fires when a context menu is about to be displayed. |
| QueryControl | Occurs when a document is to be displayed and allows you to assign content to this document. This event is in effect in Deferred Load mode. |
| QueryDocument | Occurs when the restored layout version has a Document that is not present in the View. Allows you to skip this Document or add it to the View. |
| RegisterDocumentsHostWindow | Fires when a document starts to float in its individual container. Provides access to the host window and its DocumentManager so you can handle events as required. This event is in effect in DocumentsHost mode. |
| RestoreLayoutError | Occurs when a saved layout is invalid and cannot be restored. Allows you to fix restore layout exceptions. |
| ShowingDockGuides | Allows you to hide dock guides and hints that appear when a user drags a Document or a DockPanel. |
| UnregisterDocumentsHostWindow | Fires when a documents host window is closed and allows you to unsubscribe event handlers from its DocumentManager. |
See Also