DocumentGroup Members
A group of Documents within a TabbedView.Constructors
| Name | Description |
|---|---|
| DocumentGroup() | Initializes a new instance of the DocumentGroup class. |
| DocumentGroup(IDocumentGroupProperties) | Initializes a new instance of the DocumentGroup class with the specified settings. |
| DocumentGroup(IContainer) | Initializes a new instance of the DocumentGroup class with the specified container. |
Properties
| Name | Description |
|---|---|
| AccessibleDescription | Gets or sets the object’s description used by accessibility client applications. |
| AccessibleName | Gets or sets the object’s name used by accessibility client applications. |
| AccessibleRole | Gets or sets the object’s accessible role. |
| 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. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| GroupLength | Gets or sets the width/height of the current group. This property is in effect when there are multiple groups in the TabbedView.DocumentGroups collection. |
| IsDisposing | Gets whether the BaseComponent object is currently being disposed of. Inherited from BaseComponent. |
| IsFilledUp | Gets whether the group contains the maximum possible number of documents. |
| 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. |
| Items | Contains documents displayed within the current group. This property is hidden from Visual Studio IntelliSense. Use this property to access items only. Do not add or remove items to/from the collection. |
| Manager | Gets a DocumentManager that owns the current group. |
| Properties | Provides access to the current document group’s properties. |
| SelectedDocument | Gets the currently selected document. |
| SelectedItemIndex | Gets the index of the currently selected document within the DocumentGroup.Items collection. |
| Site | Gets or sets the ISite of the Component. Inherited from Component. |
| Tag | Gets or sets an object that contains data on the current DocumentGroup object. |
| Visible | Gets or sets whether the current DocumentGroup is visible. |
Methods
| Name | Description |
|---|---|
| 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. |
| Contains(Control) | Returns whether any Document within the current DocumentGroup contains the specified Control. |
| 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. |
| DockTo(DocumentGroup, Orientation, Boolean) | Docks this DocumentGroup to the target DocumentGroup using the required orientation and order. |
| DockTo(DocumentGroup, Orientation, Int32) | Docks this DocumentGroup next to the target DocumentGroup using the desired position and orientation. |
| DockTo(DocumentGroup, Orientation) | Docks this DocumentGroup after or below the target DocumentGroup. |
| 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. |
| SetSelected(Document) | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| ToString() | Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component. |
Events
| Name | Description |
|---|---|
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| SelectionChanged | Occurs when document selection within the current DocumentGroup changes. |
| TabMouseActivating | Occurs when an end-user clicks a tab page header within the current DocumentGroup to activate a corresponding Document. |
| VisibilityChanged | Fires whenever the current DocumentGroup‘s visibility changes. |
See Also