DocumentGroup Members
The base class for all Content Containers that display multiple Documents.Properties
| Name | Description |
|---|---|
| Actions | Provides access to the collection of Custom Navigation Bar Actions used within the current Content Container. Inherited from BaseContentContainer. |
| AllowButtonGlyphSkinning | Gets or sets whether or not container buttons should paint their glyphs with the foreground color. See the Glyph Skinning help article to learn more. Inherited from BaseContentContainer. |
| AppearanceButton | Provides access to the appearance settings used to paint WindowsUI Buttons within the current Content Container. Inherited from BaseContentContainer. |
| AppearanceSubtitle | Provides access to appearance settings used to paint the current Content Container‘s BaseContentContainer.Subtitle. Inherited from BaseContentContainer. |
| ButtonBackgroundImages | Gets or sets the collection of background images for the current Content Container‘s Custom Buttons. Inherited from BaseContentContainer. |
| ButtonInterval | Gets or sets the distance between neighboring WindowsUI Buttons in the current Content Container. Inherited from BaseContentContainer. |
| Buttons | Provides access to the Content Container’s WindowsUI Buttons collection. Inherited from BaseContentContainer. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| Caption | Gets or sets the current Content Container‘s caption. Inherited from BaseContentContainer. |
| 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. |
| ExcludeFromSearch | Gets or sets whether this Content Container should be removed from the list of places where the Search Panel looks for the entered text. Inherited from BaseContentContainer. |
| Image | Gets or sets an icon for the current Content Container. Inherited from BaseContentContainer. |
| ImageOptions | Provides access to properties that allow you to set up raster and vector images for this container. Inherited from BaseContentContainer. |
| ImageUri | Gets or sets an image stored within the DevExpress Image Gallery that should be assigned to this BaseContentContainer. Inherited from BaseContentContainer. |
| Info | Gets the object providing general information about the current DocumentGroup. |
| IsActive | Gets whether the Content Container is currently active. Inherited from BaseContentContainer. |
| IsAutoCreated | Gets whether the current Content Container is created automatically. Inherited from BaseContentContainer. |
| IsDisposing | Gets whether the BaseComponent object is currently being disposed of. Inherited from BaseComponent. |
| IsFilledUp | Gets whether the number of current Content Container items has reached its limit. Inherited from BaseContentContainer. |
| IsHorizontal | Gets whether the current Content Container is orientated horizontally. Inherited from BaseContentContainer. |
| 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 if the current Content Container is loaded. Inherited from BaseContentContainer. |
| IsUpdateLocked | Returns whether or not this BaseComponent is currently locked, which prevents any visual updates. Inherited from BaseComponent. |
| Items | Provides zero-based indexed access to the collection of Documents contained within the current DocumentGroup. |
| Manager | Gets a DocumentManager that owns the current Content Container. Inherited from BaseContentContainer. |
| Name | Gets or sets the current Content Container‘s name. Inherited from BaseContentContainer. |
| Parent | Gets or sets the current Content Container‘s parent Container. Inherited from BaseContentContainer. |
| Properties | Provides access to the current Content Container‘s general settings. Inherited from BaseContentContainer. |
| SearchTags | Gets or sets the collection of string tags for this BaseContentContainer. The Search Panel will check these tags for the desired text. Inherited from BaseContentContainer. |
| Site | Gets or sets the ISite of the Component. Inherited from Component. |
| Subtitle | Gets or sets the current Content Container‘s subtitle. Inherited from BaseContentContainer. |
| Tag | Gets or sets a tag that labels this BaseContentContainer. Inherited from BaseContentContainer. |
| UseButtonBackgroundImages | Gets or sets whether or not container buttons should display their background images. Inherited from BaseContentContainer. |
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. |
| 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. |
| GetEnumerator() | Gets an Enumerator that can iterate through the BaseContentContainer‘s content. Inherited from BaseContentContainer. |
| GetEnumerator(IContentContainer, Predicate<IContentContainer>, Int32) static | Gets an enumerator that goes down the BaseContentContainer‘s hierarchy and iterates the children that meet a specific set of criteria. Inherited from BaseContentContainer. |
| GetEnumerator(Int32) | Gets an enumerator that goes down the BaseContentContainer‘s hierarchy and iterates its children. Inherited from BaseContentContainer. |
| GetEnumerator(Predicate<IContentContainer>) | Gets an enumerator that iterates through the current BaseContentContainer with a specific criteria. Inherited from BaseContentContainer. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetLength(Document) | Gets a specific Document‘s length within the current DocumentGroup. |
| GetLengths() | Gets an Int32 array whose every item specifies the length of a corresponding Document within a SplitGroup or a SlideGroup. |
| GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| GetRoot(IContentContainer) static | Gets the root parent for the specific Content Container. Inherited from BaseContentContainer. |
| 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. |
| IsChild(IContentContainer, IContentContainer) static | Gets whether the ‘container’ Content Container is the ‘parent’ container’s child. Inherited from BaseContentContainer. |
| 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. |
| SetLength(Document, Int32) | Sets a specific Document‘s length within the current DocumentGroup. |
| ToString() | Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component. |
| UpdateDocumentActions() | Refreshes document actions displayed within this BaseContentContainer‘s child documents. Inherited from BaseContentContainer. |
Events
| Name | Description |
|---|---|
| ActionCustomization | Occurs whenever Navigation Bars within the current BaseContentContainer are to be displayed. Allows you to customize this container’s Navigation Bar Actions. Inherited from BaseContentContainer. |
| ActualActionsChanged | Fires when the current Content Container‘s actions collection changes. Inherited from BaseContentContainer. |
| ButtonChecked | Occurs when a Custom Button within the current Content Container is checked. Inherited from BaseContentContainer. |
| ButtonClick | Occurs when a regular Custom Button within the current Content Container is clicked. Inherited from BaseContentContainer. |
| ButtonUnchecked | Occurs when a Custom Button within the current Content Container is checked. Inherited from BaseContentContainer. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| HeaderClick | Occurs whenever an end-user clicks a header of a Document that belongs to this DocumentGroup container. |
See Also