Back to Devexpress

BaseContentContainer Members

windowsforms-devexpress-dot-xtrabars-dot-docking2010-dot-views-dot-windowsui-dot-basecontentcontainer-dot-underscore-members.md

latest23.3 KB
Original Source

BaseContentContainer Members

A base class for all Content Containers types used within a WindowsUIView.

Properties

NameDescription
ActionsProvides access to the collection of Custom Navigation Bar Actions used within the current Content Container.
AllowButtonGlyphSkinningGets or sets whether or not container buttons should paint their glyphs with the foreground color. See the Glyph Skinning help article to learn more.
AppearanceButtonProvides access to the appearance settings used to paint WindowsUI Buttons within the current Content Container.
AppearanceSubtitleProvides access to appearance settings used to paint the current Content Container‘s BaseContentContainer.Subtitle.
ButtonBackgroundImagesGets or sets the collection of background images for the current Content Container‘s Custom Buttons.
ButtonIntervalGets or sets the distance between neighboring WindowsUI Buttons in the current Content Container.
ButtonsProvides access to the Content Container’s WindowsUI Buttons collection.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CaptionGets or sets the current Content Container‘s caption.
ContainerGets the IContainer that contains the Component. Inherited from Component.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExcludeFromSearchGets or sets whether this Content Container should be removed from the list of places where the Search Panel looks for the entered text.
ImageGets or sets an icon for the current Content Container.
ImageOptionsProvides access to properties that allow you to set up raster and vector images for this container.
ImageUriGets or sets an image stored within the DevExpress Image Gallery that should be assigned to this BaseContentContainer.
InfoGets specific information about the current Content Container.
IsActiveGets whether the Content Container is currently active.
IsAutoCreatedGets whether the current Content Container is created automatically.
IsDisposingGets whether the BaseComponent object is currently being disposed of. Inherited from BaseComponent.
IsFilledUpGets whether the number of current Content Container items has reached its limit.
IsHorizontalGets whether the current Content Container is orientated horizontally.
IsInitializedIndicates whether or not the BaseComponent object has been fully initialized. Inherited from BaseComponent.
IsInitializingReturns whether or not the BaseComponent object is currently being initialized. Inherited from BaseComponent.
IsLoadedGets if the current Content Container is loaded.
IsUpdateLockedReturns whether or not this BaseComponent is currently locked, which prevents any visual updates. Inherited from BaseComponent.
ManagerGets a DocumentManager that owns the current Content Container.
NameGets or sets the current Content Container‘s name.
ParentGets or sets the current Content Container‘s parent Container.
PropertiesProvides access to the current Content Container‘s general settings.
SearchTagsGets or sets the collection of string tags for this BaseContentContainer. The Search Panel will check these tags for the desired text.
SiteGets or sets the ISite of the Component. Inherited from Component.
SubtitleGets or sets the current Content Container‘s subtitle.
TagGets or sets a tag that labels this BaseContentContainer.
UseButtonBackgroundImagesGets or sets whether or not container buttons should display their background images.

Methods

NameDescription
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) staticDetermines 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.
GetEnumerator(IContentContainer, Predicate<IContentContainer>, Int32) staticGets an enumerator that goes down the BaseContentContainer‘s hierarchy and iterates the children that meet a specific set of criteria.
GetEnumerator(Int32)Gets an enumerator that goes down the BaseContentContainer‘s hierarchy and iterates its children.
GetEnumerator(Predicate<IContentContainer>)Gets an enumerator that iterates through the current BaseContentContainer with a specific criteria.
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.
GetRoot(IContentContainer) staticGets the root parent for the specific Content Container.
GetService(Type) protectedReturns 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) staticGets whether the ‘container’ Content Container is the ‘parent’ container’s child.
LayoutChanged()Updates the element. Inherited from BaseComponent.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
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.

Events

NameDescription
ActionCustomizationOccurs whenever Navigation Bars within the current BaseContentContainer are to be displayed. Allows you to customize this container’s Navigation Bar Actions.
ActualActionsChangedFires when the current Content Container‘s actions collection changes.
ButtonCheckedOccurs when a Custom Button within the current Content Container is checked.
ButtonClickOccurs when a regular Custom Button within the current Content Container is clicked.
ButtonUncheckedOccurs when a Custom Button within the current Content Container is checked.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.

See Also

BaseContentContainer Class

DevExpress.XtraBars.Docking2010.Views.WindowsUI Namespace