WidgetView Members
A Widget View.Constructors
| Name | Description |
|---|---|
| WidgetView() | Initializes a new instance of the WidgetView class with the default settings. |
| WidgetView(IContainer) | Initializes a new instance of the WidgetView class with the specified settings. |
Properties
| Name | Description |
|---|---|
| ActiveDocument | Gets the active document. Inherited from BaseView. |
| ActiveFloatDocument | Gets the active floating document. Inherited from BaseView. |
| AllowDocumentCaptionColorBlending | Gets or sets whether or not the document header text should be colorized according to the caption area fore color. |
| AllowDocumentStateChangeAnimation | Gets or sets whether changing the Documents’ state within this WidgetView should be followed with animation effects. |
| AllowDragDropWobbleAnimation | Gets or sets whether wobble animation for Table Layout mode is enabled. |
| AllowHotkeyNavigation | Gets or sets whether switching between tabbed documents using keyboard shortcuts is allowed. Inherited from BaseView. |
| AllowResetLayout | Gets or sets whether the current DocumentManager‘s layout can be reset to default. Inherited from BaseView. |
| AllowResizeAnimation | Gets or sets whether Documents within this WidgetView are resized using a smooth animation effect. |
| AllowStartupAnimation | Gets or sets whether or not this WidgetView‘s content should be displayed with a light animation when displayed. |
| Appearance | Contains appearance settings for the current View. Inherited from BaseView. |
| AppearanceActiveDocumentCaption | Stores appearance settings used to paint the header of the currently active Document. |
| AppearanceDocumentCaption | Stores appearance settings for Document headers. |
| BackgroundImage | Gets or sets the current DocumentManager‘s background image. Inherited from BaseView. |
| BackgroundImageLayoutMode | Gets or sets the background image layout as defined in the ImageLayoutMode enumeration. Inherited from BaseView. |
| BackgroundImageStretchMargins | Gets or sets stretching margins for a DocumentManager‘s background image in a View. Inherited from BaseView. |
| Bounds | Gets the visual bounds of the current object. Inherited from BaseView. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| Columns | Provides access to the column collection for this WidgetView. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| Controller | Provides access to the WidgetView controller. |
| CustomResizeZoneThickness | Gets or sets the resize zone thickness. Inherited from BaseView. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| DocumentAnimationProperties | Provides access to properties that manage document animation for this WidgetView. |
| DocumentGroup | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| DocumentProperties | Provides access to properties, common to all Documents within this WidgetView. |
| Documents | Stores all documents displayed within the View. Inherited from BaseView. |
| DocumentSelectorProperties | Provides access to appearance settings used for a Document Selector within the current view. Inherited from BaseView. |
| DocumentSpacing | Gets or sets the Document margins within this WidgetView. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| FloatDocuments | Provides access to floating documents. Inherited from BaseView. |
| FloatDocumentsAlwaysOnTop | Gets or sets whether floating Documents are always drawn on top of their parent forms. Inherited from BaseView. |
| FloatingDocumentContainer | Gets or sets a type of container for floating documents within the current BaseView. Inherited from BaseView. |
| FloatPanels | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from BaseView. |
| FlowLayoutProperties | Provides access to the FlowLayoutProperties settings when this View is in Flow Layout mode. |
| FreeLayoutProperties | Provides access to settings related to the Free Layout Mode. |
| 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. Inherited from BaseView. |
| IsEmpty | Gets whether a View is empty. Inherited from BaseView. |
| IsFocused | Gets whether any document within the current View has focus. Inherited from BaseView. |
| 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. Inherited from BaseView. |
| IsLoading | Gets whether the current object is being loaded. Inherited from BaseView. |
| IsLoadingAnimationInProgress | Gets whether loading indicator animation is currently running within this View. Inherited from BaseView. |
| 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. Inherited from BaseView. |
| LayoutMode | Gets or sets the current layout mode for this WidgetView. |
| LoadingIndicatorProperties | Provides access to appearance settings used for a loading indicator within the current BaseView. Inherited from BaseView. |
| Manager | Gets a DocumentManager that owns the current View. Inherited from BaseView. |
| OptionsLayout | Gets the object containing properties related to the current View’s layout. Inherited from BaseView. |
| Orientation | Gets or sets this WidgetView‘s orientation. |
| Padding | This is an internal property that should not be used. Inherited from BaseView. |
| RootContainer | Returns the root docking container for this WidgetView. |
| Rows | Provides access to the row collection for this WidgetView. |
| Site | Gets or sets the ISite of the Component. Inherited from Component. |
| StackGroupProperties | Provides access to the set of properties common to all StackGroups within this WidgetView. |
| StackGroups | Gets the collection of StackGroups used within this WidgetView. |
| Style | Gets or sets the View style. Inherited from BaseView. |
| Type | Gets the type of the current WidgetView. |
| UseDocumentSelector | Gets or sets if a Document Selector is enabled for the current Document Manager. Inherited from BaseView. |
| UseLoadingIndicator | Gets or sets if a loading indicator for deferred load should be used. Inherited from BaseView. |
| UseSnappingEmulation | Gets or sets whether this BaseView uses snapping emulation for its child documents. Inherited from BaseView. |
| WindowsDialogProperties | Gets an object containing settings related to the current DocumentManager‘s Windows dialog. Inherited from BaseView. |
Methods
| Name | Description |
|---|---|
| ActivateDocument(Control) | Activates the document that displays the specified control. Inherited from BaseView. |
| AddDocument(String, String) | Adds an empty Document with specified BaseDocument.Caption and BaseDocument.ControlName properties to the current View. Inherited from BaseView. |
| AddDocument(Control, String) | Creates a Document that wraps the target control, and adds this new Document to the current BaseView. Inherited from 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. Inherited from BaseView. |
| AddFloatDocument(Control, Point) | Creates the floating document that hosts the target control and is displayed at the given position. Inherited from BaseView. |
| AddFloatDocument(Control, String) | Creates a floating document that hosts the target control. Inherited from BaseView. |
| AddFloatingDocumentsHost(BaseDocument) | Creates a documents host window that contains the specified document. This method is in effect in the DocumentsHost mode. Inherited from BaseView. |
| AddFloatingDocumentsHost(BaseDocument[]) | Creates a floating documents host (container) that will contain the specific BaseDocument objects collection. Inherited from BaseView. |
| 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. Inherited from BaseView. |
| 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. Inherited from BaseView. |
| BeginUpdate() | Locks the BaseComponent, preventing visual updates of the object and its elements until the EndUpdate or CancelUpdate method is called. Inherited from BaseComponent. |
| BeginUpdateAnimation() | Locks the current layout and prevents it from playing document animation. |
| 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. |
| EndUpdateAnimation() | Unlocks this WidgetView and animates all changes executed to its layout. |
| 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. Inherited from BaseView. |
| ReleaseDeferredLoadControl(BaseDocument, Boolean) | Fires the BaseView.ControlReleasing event with the specified parameter for the specified document. Inherited from BaseView. |
| ReleaseDeferredLoadControl(BaseDocument) | Disposes a specific deferred load Document within the current View. Inherited from BaseView. |
| ReleaseDeferredLoadControls() | Disposes all deferred load Documents within the current view. Inherited from BaseView. |
| ReleaseDeferredLoadControls(Boolean, Boolean) | Fires the BaseView.ControlReleasing event with the specified parameters for all documents with unreleased content in the current BaseView. Inherited from BaseView. |
| ReleaseDeferredLoadControls(Boolean) | Fires the BaseView.ControlReleasing event with the specified parameter for all documents with unreleased content in the current BaseView. Inherited from BaseView. |
| ReleaseDeferredLoadMaximizedControl(Document, Boolean, Boolean) | Raises the WidgetView.MaximizedControlReleasing event for the target document and sets its initial ControlReleasingEventArgs.KeepControl and ControlReleasingEventArgs.DisposeControl parameters. |
| ReleaseDeferredLoadMaximizedControl(Document, Boolean) | Raises the WidgetView.MaximizedControlReleasing event for the target document and specifies whether its maximized control should be retained. |
| ReleaseDeferredLoadMaximizedControl(Document) | Raises the WidgetView.MaximizedControlReleasing event with default parameters for the target document. |
| ReleaseDeferredLoadMaximizedControls() | Raises the WidgetView.MaximizedControlReleasing event for all deferred WidgetView documents. |
| ReleaseDeferredLoadMaximizedControls(Boolean, Boolean) | Raises the WidgetView.MaximizedControlReleasing event for all deferred WidgetView documents and sets the initial ControlReleasingEventArgs.KeepControl and ControlReleasingEventArgs.DisposeControl parameter values for this event. |
| ReleaseDeferredLoadMaximizedControls(Boolean) | Raises the WidgetView.MaximizedControlReleasing event for all deferred WidgetView documents and sets the initial ControlReleasingEventArgs.KeepControl parameter for this event. |
| RemoveDocument(Control) | Removes a document whose BaseDocument.Control property’s value matches the specified control object. Inherited from BaseView. |
| ResetDocumentAnimationProperties() | Resets all properties stored within the WidgetView.DocumentAnimationProperties section to their default values. |
| ResetFlowLayoutProperties() | Resets all properties stored within the WidgetView.FlowLayoutProperties section to their default values. |
| ResetFreeLayoutProperties() | Resets all properties from the WidgetView.FreeLayoutProperties section to their default values. |
| RestoreLayoutFromRegistry(String) | Restores the layout from a specific registry key. Inherited from BaseView. |
| RestoreLayoutFromStream(Stream, Boolean) | Restores the layout from a stream that contains data in a specific format. Inherited from BaseView. |
| RestoreLayoutFromStream(Stream) | Restores the layout from a stream that contains data in binary format. Inherited from BaseView. |
| RestoreLayoutFromXml(Stream) | Restores the layout from a specific stream that contains data in XML format. Inherited from BaseView. |
| RestoreLayoutFromXml(String) | Restores the layout from a specific XML file. Inherited from BaseView. |
| ResumeLayout() | Unlocks the WidgetView layout and makes it reflect all previously applied changes. |
| SaveLayoutToRegistry(String) | Saves the layout in the system registry. Inherited from BaseView. |
| SaveLayoutToStream(Stream, Boolean) | Saves the layout in a specific stream in binary format. Inherited from BaseView. |
| SaveLayoutToStream(Stream) | Saves the layout in a specific stream in binary format. Inherited from BaseView. |
| SaveLayoutToXml(Stream) | Saves the layout in a specific stream in XML format. Inherited from BaseView. |
| SaveLayoutToXml(String) | Saves the layout in a specific file in XML format. Inherited from BaseView. |
| ScrollToActiveDocument(Document) | Scrolls this WidgetView up or down to the target document. |
| ShouldSerializeDocumentAnimationProperties() | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| ShouldSerializeFlowLayoutProperties() | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| ShouldSerializeFreeLayoutProperties() | Checks whether or not settings related to Free Layout Mode should be serialized. |
| SuspendLayout() | Freezes the current WidgetView layout. |
| ToString() | Gets the text representation of the BaseView object. Inherited from BaseView. |
Events
| Name | Description |
|---|---|
| BeforeLoadLayout | Fires when the View attempts to restore a previously saved layout version. Allows you to cancel this restoration. Inherited from BaseView. |
| BeginDocking | Allows you to cancel docking a document onto the current control. Inherited from BaseView. |
| BeginDocumentsHostDocking | Occurs whenever a Floating Documents Container starts docking to this BaseView. Inherited from BaseView. |
| BeginDragging | Occurs whenever an end-user tries to drag a Document. |
| BeginFloating | Fires when an end-user starts to drag a docked document, so that it is transformed into a floating window. Inherited from BaseView. |
| BeginSizing | Occurs when a resizing of the current View’s layout begins. Inherited from BaseView. |
| BeginStackGroupDragging | Occurs immediately after an end-user moves a StackGroup within this WidgetView. |
| ControlLoaded | Occurs after a control has been loaded to a Document within this BaseView. Inherited from BaseView. |
| ControlReleased | Fires after a control has been succesfully unbound from its parent document. Inherited from BaseView. |
| 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. Inherited from BaseView. |
| ControlShown | Fires when an empty document is loaded and displayed. Inherited from BaseView. |
| CustomDocumentsHostWindow | Allows you to replace the default container for floating documents. Handle this event only when the BaseView.FloatingDocumentContainer property equals DocumentsHost. Inherited from BaseView. |
| CustomDrawBackground | Occurs when the current View’s background becomes visible to an end-user. Inherited from BaseView. |
| 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. Inherited from BaseView. |
| DocumentAdded | Fires when a new document is added to the current View. Inherited from BaseView. |
| DocumentClosed | Fires after a document has been closed. Inherited from BaseView. |
| DocumentClosing | Fires when a document is about to be closed. Inherited from BaseView. |
| DocumentDeactivated | Fires when a document is deactivated. Inherited from BaseView. |
| DocumentRemoved | Fires when a document is removed from the BaseView.Documents collection. Inherited from BaseView. |
| DocumentSelectorCustomSortItems | Allows you to manually sort documents and dock panels displayed within the Document Selector. Inherited from BaseView. |
| DocumentSelectorHidden | Fires when a document selector is closed. Inherited from BaseView. |
| DocumentSelectorShown | Fires when a document selector is displayed. Inherited from BaseView. |
| Dragging | Occurs when a Document within this WidgetView is dragged. |
| 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. Inherited from BaseView. |
| EndDocking | Fires after a document has been docked to the control. Inherited from BaseView. |
| EndDocumentsHostDocking | Occurs when a Floating Document Container with all its child Documents is docked to a View. Inherited from BaseView. |
| EndDragging | Occurs whenever an end-user drops a Document after dragging. |
| EndFloating | Fires after an end-user drops a floating document. Inherited from BaseView. |
| EndSizing | Occurs when resizing the current View’s layout is complete. Inherited from BaseView. |
| EndStackGroupDragging | Occurs when an end-user drops a dragged StackGroup. |
| Floating | Fires when a docked document becomes floating. Inherited from BaseView. |
| GotFocus | Fires when focus is moved to any document within the current View. Inherited from BaseView. |
| Layout | Occurs whenever the current DocumentManager‘s layout is being modified. Inherited from BaseView. |
| LayoutReset | Fires after a DocumentManager‘s layout was reset. Inherited from BaseView. |
| LayoutResetting | Occurs when the current BaseView‘s layout is to be reset. Inherited from BaseView. |
| 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). Inherited from BaseView. |
| LoadingIndicatorShowing | Occurs when the loading indicator is shown within this BaseView. Inherited from BaseView. |
| LostFocus | Fires when focus is moved from the current View’s document to any external control (for instance, to an external DockPanel). Inherited from BaseView. |
| MaximizedControlLoaded | Fires after a WidgetView document receives its maximized control on the WidgetView.QueryMaximizedControl event. |
| MaximizedControlReleased | Fires after the WidgetView document was destroyed. |
| MaximizedControlReleasing | Occurs when a WidgetView document is minimized back to its regular state and allows you to destroy its maximized content. |
| NextDocument | Fires when an end-user tries to switch to the next or previous document by pressing CTRL+TAB or CTRL+SHIFT+TAB. Inherited from BaseView. |
| Paint | Occurs when the BaseView is redrawn. Inherited from BaseView. |
| PopupMenuShowing | Fires when a context menu is about to be displayed. Inherited from BaseView. |
| 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. Inherited from BaseView. |
| 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. Inherited from BaseView. |
| QueryMaximizedControl | Allows you to dynamically assign a maximized control for each widget document. |
| 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. Inherited from BaseView. |
| RestoreLayoutError | Occurs when a saved layout is invalid and cannot be restored. Allows you to fix restore layout exceptions. Inherited from BaseView. |
| ShowingDockGuides | Allows you to hide dock guides and hints that appear when a user drags a Document or a DockPanel. Inherited from BaseView. |
| UnregisterDocumentsHostWindow | Fires when a documents host window is closed and allows you to unsubscribe event handlers from its DocumentManager. Inherited from BaseView. |
See Also