WidgetView Members
In This Article
#Constructors
Name | Description |
---|---|
Widget |
Initializes a new instance of the Widget |
Widget |
Initializes a new instance of the Widget |
#Properties
Name | Description |
---|---|
Active |
Gets the active document.
Inherited from Base |
Active |
Gets the active floating document.
Inherited from Base |
Allow |
Gets or sets whether or not the document header text should be colorized according to the caption area fore color. |
Allow |
Gets or sets whether changing the Documents’ state within this Widget |
Allow |
Gets or sets whether wobble animation for Table Layout mode is enabled. |
Allow |
Gets or sets whether switching between tabbed documents using keyboard shortcuts is allowed.
Inherited from Base |
Allow |
Gets or sets whether the current Document |
Allow |
Gets or sets whether Documents within this Widget |
Allow |
Gets or sets whether or not this Widget |
Appearance |
Contains appearance settings for the current View.
Inherited from Base |
Appearance |
Stores appearance settings used to paint the header of the currently active Document. |
Appearance |
Stores appearance settings for Document headers. |
Background |
Gets or sets the current Document |
Background |
Gets or sets the background image layout as defined in the Image |
Background |
Gets or sets stretching margins for a Document |
Bounds |
Gets the visual bounds of the current object.
Inherited from Base |
Can |
Gets a value indicating whether the component can raise an event. Inherited from Component. |
Columns |
Provides access to the column collection for this Widget |
Container | Gets the IContainer that contains the Component. Inherited from Component. |
Controller |
Provides access to the Widget |
Custom |
Gets or sets the resize zone thickness.
Inherited from Base |
Design |
Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
Document |
Provides access to properties that manage document animation for this Widget |
Document |
This member supports the internal infrastructure, and is not intended to be used directly from your code. |
Document |
Provides access to properties, common to all Documents within this Widget |
Documents |
Stores all documents displayed within the View.
Inherited from Base |
Document |
Provides access to appearance settings used for a Document Selector within the current view.
Inherited from Base |
Document |
Gets or sets the Document margins within this Widget |
Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
Float |
Provides access to floating documents.
Inherited from Base |
Float |
Gets or sets whether floating Documents are always drawn on top of their parent forms.
Inherited from Base |
Floating |
Gets or sets a type of container for floating documents within the current Base |
Float |
This member supports the internal infrastructure, and is not intended to be used directly from your code.
Inherited from Base |
Flow |
Provides access to the Flow |
Free |
Provides access to settings related to the Free Layout Mode. |
Is |
Gets whether the Base |
Is |
Gets if a document selector for this Base |
Is |
Gets whether a View is empty.
Inherited from Base |
Is |
Gets whether any document within the current View has focus.
Inherited from Base |
Is |
Indicates whether or not the Base |
Is |
Returns whether or not the Base |
Is |
Gets whether the current object has been loaded.
Inherited from Base |
Is |
Gets whether the current object is being loaded.
Inherited from Base |
Is |
Gets whether loading indicator animation is currently running within this View.
Inherited from Base |
Is |
Returns whether or not this Base |
Items |
This member supports the internal infrastructure, and is not intended to be used directly from your code.
Inherited from Base |
Layout |
Gets or sets the current layout mode for this Widget |
Loading |
Provides access to appearance settings used for a loading indicator within the current Base |
Manager |
Gets a Document |
Options |
Gets the object containing properties related to the current View’s layout.
Inherited from Base |
Orientation |
Gets or sets this Widget |
Padding |
This is an internal property that should not be used.
Inherited from Base |
Root |
Returns the root docking container for this Widget |
Rows |
Provides access to the row collection for this Widget |
Site | Gets or sets the ISite of the Component. Inherited from Component. |
Stack |
Provides access to the set of properties common to all Stack |
Stack |
Gets the collection of Stack |
Style |
Gets or sets the View style.
Inherited from Base |
Type |
Gets the type of the current Widget |
Use |
Gets or sets if a Document Selector is enabled for the current Document Manager.
Inherited from Base |
Use |
Gets or sets if a loading indicator for deferred load should be used.
Inherited from Base |
Use |
Gets or sets whether this Base |
Windows |
Gets an object containing settings related to the current Document |
#Methods
Name | Description |
---|---|
Activate |
Activates the document that displays the specified control.
Inherited from Base |
Add |
Adds an empty Document with specified Base |
Add |
Creates a Document that wraps the target control, and adds this new Document to the current Base |
Add |
Creates a floating document that hosts the target control, has the required size, and is displayed in the given location.
Inherited from Base |
Add |
Creates the floating document that hosts the target control and is displayed at the given position.
Inherited from Base |
Add |
Creates a floating document that hosts the target control.
Inherited from Base |
Add |
Creates a documents host window that contains the specified document. This method is in effect in the Documents |
Add |
Creates a floating documents host (container) that will contain the specific Base |
Add |
Creates a documents host window that contains a newly created document wrapping the specified control. This method is in effect in the Documents |
Add |
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 Base |
Begin |
Locks the Base |
Begin |
Locks the current layout and prevents it from playing document animation. |
Cancel |
Unlocks the Base |
Create |
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Inherited from Marshal |
Dispose() | Releases all resources used by the Component. Inherited from Component. |
End |
Unlocks the Base |
End |
Unlocks this Widget |
Equals |
Determines whether the specified object instances are considered equal. Inherited from Object. |
Equals |
Determines whether the specified object is equal to the current object. Inherited from Object. |
Get |
Serves as the default hash function. Inherited from Object. |
Get |
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
Inherited from Marshal |
Get |
Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
Get |
Gets the Type of the current instance. Inherited from Object. |
Initialize |
Obtains a lifetime service object to control the lifetime policy for this instance.
Inherited from Marshal |
Layout |
Updates the element.
Inherited from Base |
Memberwise |
Creates a shallow copy of the current Object. Inherited from Object. |
Memberwise |
Creates a shallow copy of the current Marshal |
Reference |
Determines whether the specified Object instances are the same instance. Inherited from Object. |
Release |
Fires the Base |
Release |
Fires the Base |
Release |
Disposes a specific deferred load Document within the current View.
Inherited from Base |
Release |
Disposes all deferred load Documents within the current view.
Inherited from Base |
Release |
Fires the Base |
Release |
Fires the Base |
Release |
Raises the Widget |
Release |
Raises the Widget |
Release |
Raises the Widget |
Release |
Raises the Widget |
Release |
Raises the Widget |
Release |
Raises the Widget |
Remove |
Removes a document whose Base |
Reset |
Resets all properties stored within the Widget |
Reset |
Resets all properties stored within the Widget |
Reset |
Resets all properties from the Widget |
Restore |
Restores the layout from a specific registry key.
Inherited from Base |
Restore |
Restores the layout from a stream that contains data in a specific format.
Inherited from Base |
Restore |
Restores the layout from a stream that contains data in binary format.
Inherited from Base |
Restore |
Restores the layout from a specific stream that contains data in XML format.
Inherited from Base |
Restore |
Restores the layout from a specific XML file.
Inherited from Base |
Resume |
Unlocks the Widget |
Save |
Saves the layout in the system registry.
Inherited from Base |
Save |
Saves the layout in a specific stream in binary format.
Inherited from Base |
Save |
Saves the layout in a specific stream in binary format.
Inherited from Base |
Save |
Saves the layout in a specific stream in XML format.
Inherited from Base |
Save |
Saves the layout in a specific file in XML format.
Inherited from Base |
Scroll |
Scrolls this Widget |
Should |
This member supports the internal infrastructure, and is not intended to be used directly from your code. |
Should |
This member supports the internal infrastructure, and is not intended to be used directly from your code. |
Should |
Checks whether or not settings related to Free Layout Mode should be serialized. |
Suspend |
Freezes the current Widget |
To |
Gets the text representation of the Base |
#Events
Name | Description |
---|---|
Before |
Fires when the View attempts to restore a previously saved layout version. Allows you to cancel this restoration.
Inherited from Base |
Begin |
Allows you to cancel docking a document onto the current control.
Inherited from Base |
Begin |
Occurs whenever a Floating Documents Container starts docking to this Base |
Begin |
Occurs whenever an end-user tries to drag a Document. |
Begin |
Fires when an end-user starts to drag a docked document, so that it is transformed into a floating window.
Inherited from Base |
Begin |
Occurs when a resizing of the current View’s layout begins.
Inherited from Base |
Begin |
Occurs immediately after an end-user moves a Stack |
Control |
Occurs after a control has been loaded to a Document within this Base |
Control |
Fires after a control has been succesfully unbound from its parent document.
Inherited from Base |
Control |
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 Base |
Control |
Fires when an empty document is loaded and displayed.
Inherited from Base |
Custom |
Allows you to replace the default container for floating documents. Handle this event only when the Base |
Custom |
Occurs when the current View’s background becomes visible to an end-user.
Inherited from Base |
Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
Document |
Fires when the View’s Active |
Document |
Fires when a new document is added to the current View.
Inherited from Base |
Document |
Fires after a document has been closed.
Inherited from Base |
Document |
Fires when a document is about to be closed.
Inherited from Base |
Document |
Fires when a document is deactivated.
Inherited from Base |
Document |
Fires when a document is removed from the Base |
Document |
Allows you to manually sort documents and dock panels displayed within the Document Selector.
Inherited from Base |
Document |
Fires when a document selector is closed.
Inherited from Base |
Document |
Fires when a document selector is displayed.
Inherited from Base |
Dragging |
Occurs when a Document within this Widget |
Empty |
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 Base |
End |
Fires after a document has been docked to the control.
Inherited from Base |
End |
Occurs when a Floating Document Container with all its child Documents is docked to a View.
Inherited from Base |
End |
Occurs whenever an end-user drops a Document after dragging. |
End |
Fires after an end-user drops a floating document.
Inherited from Base |
End |
Occurs when resizing the current View’s layout is complete.
Inherited from Base |
End |
Occurs when an end-user drops a dragged Stack |
Floating |
Fires when a docked document becomes floating.
Inherited from Base |
Got |
Fires when focus is moved to any document within the current View.
Inherited from Base |
Layout |
Occurs whenever the current Document |
Layout |
Fires after a Document |
Layout |
Occurs when the current Base |
Layout |
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 Base |
Loading |
Occurs when the loading indicator is shown within this Base |
Lost |
Fires when focus is moved from the current View’s document to any external control (for instance, to an external Dock |
Maximized |
Fires after a Widget |
Maximized |
Fires after the Widget |
Maximized |
Occurs when a Widget |
Next |
Fires when an end-user tries to switch to the next or previous document by pressing CTRL+TAB or CTRL+SHIFT+TAB.
Inherited from Base |
Paint |
Occurs when the Base |
Popup |
Fires when a context menu is about to be displayed.
Inherited from Base |
Query |
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 Base |
Query |
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 Base |
Query |
Allows you to dynamically assign a maximized control for each widget document. |
Register |
Fires when a document starts to float in its individual container. Provides access to the host window and its Document |
Restore |
Occurs when a saved layout is invalid and cannot be restored. Allows you to fix restore layout exceptions.
Inherited from Base |
Showing |
Allows you to hide dock guides and hints that appear when a user drags a Document or a Dock |
Unregister |
Fires when a documents host window is closed and allows you to unsubscribe event handlers from its Document |
See Also