Back to Devexpress

XtraTabbedMdiManager Members

windowsforms-devexpress-dot-xtratabbedmdi-dot-xtratabbedmdimanager-dot-underscore-members.md

latest23.1 KB
Original Source

XtraTabbedMdiManager Members

The component that displays MDI child forms as tabs and provides basic form management features. To create an advanced tabbed UI, use the DocumentManager component instead.

Constructors

NameDescription
XtraTabbedMdiManager()Initializes a new instance of the XtraTabbedMdiManager class with default settings.
XtraTabbedMdiManager(IContainer)Initializes a new instance of the XtraTabbedMdiManager class which is associated with the specified container.

Properties

NameDescription
AccessibleDescriptionGets or sets the object’s description used by accessibility client applications.
AccessibleNameGets or sets the object’s name used by accessibility client applications.
AccessibleRoleGets or sets the object’s accessible role.
ActiveFloatFormGets the currently active floating page.
AllowDragDropGets or sets whether end-users can reorder pages by dragging their headers.
AllowGlyphSkinningGets or sets whether icons for all XtraMdiTabPages within the XtraTabbedMdiManager should be painted with the same color as the page header text.
AppearanceGets the appearance settings used to paint the MDI client.
AppearancePageProvides access to the properties that control the appearance of all the pages.
BorderStyleGets or sets the border style of the multiple document interface (MDI) client.
BorderStylePageGets or sets the border style of all the tab pages.
BoundsGets the bounding rectangle of the multiple document interface (MDI) client.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
ClosePageButtonShowModeGets or sets whether Close buttons are displayed in individual tab pages and the tab control’s header.
CloseTabOnMiddleClickGets or sets the value that determines if tabs will be closed on a mouse middle click.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ControllerGets or sets the bar and dock controller that controls the appearance settings of the XtraTabbedMdiManager 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.
FloatFormsProvides access to the collection of floating pages.
FloatMDIChildDockDelayGets or sets the time interval between moving a floating page onto the tab header region and docking the page.
FloatOnDoubleClickGets or sets whether a page is made floating on double-clicking its tab.
FloatOnDragGets or sets whether a page can be dragged away from the XtraTabbedMdiManager and then restored.
FloatPageDragModeGets or sets how a page is dragged away from the XtraTabbedMdiManager‘s header region.
HandlerThis member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
HeaderAutoFillGets or sets whether the page headers should be automatically stretched to fill the empty space in a tab row.
HeaderButtonsGets the options that specify which tab buttons can be displayed within the header panel.
HeaderButtonsShowModeGets or sets a value which specifies the display mode for the header buttons.
HeaderLocationGets or sets the position of the page headers.
HeaderOrientationGets or sets the orientation of the page headers.
ImagesGets or sets the source of images that can be displayed within page headers. Use the ImageIndex property in XtraMdiTabPage.ImageOptions to assign an image to a page.
MaxTabPageWidthGets or sets the default maximum width of tab headers for all pages.
MdiParentGets or sets a container for multiple document interface (MDI) child forms.
MultiLineGets or sets whether more than one row of page headers can be displayed.
PageImagePositionGets or sets the alignment of the image displayed within the page header.
PagesProvides access to the tabbed MDI manager’s page collection.
PinPageButtonShowModeGets or sets which XtraMdiTabPages should display a Pin Button on their tab headers.
PreviewPageZoomRatioGets or sets the zoom ratio to calculate the size of a floating page’s preview version.
RightToLeftLayoutGets or sets whether right-to-left mirror placement is turned on.
SelectedPageGets or sets the currently selected page.
SetNextMdiChildModeGets or sets a value which specifies the order in which pages are cycled through.
ShowFloatingDropHintGets or sets whether hints are displayed to indicate positions when a floating page is being dragged-and-dropped onto the XtraTabbedMdiManager‘s header region.
ShowHeaderFocusGets or sets whether a focus frame is displayed around the selected page header.
ShowToolTipsGets or sets whether hints can be displayed for page headers.
SiteGets or sets the ISite of the Component. Inherited from Component.
TabPageWidthGets or sets the width for all tab page headers within the XtraTabbedMdiManager.
ToolTipControllerGets or sets the tooltip controller component that controls the appearance, position and content of the hints displayed for tab pages.
UseDocumentSelectorGets or sets whether the Document Selector feature is enabled, which allows an end-user to switch between tab pages.
UseFormIconAsPageImageGets or sets whether to display a child form’s icon (Form.Icon) in the corresponding page header.

Methods

NameDescription
BeginUpdate()Locks the XtraTabbedMdiManager object by preventing visual updates of the object and its elements until the EndUpdate method is called.
CalcHitInfo(Point)Returns information on the visual elements located at the specified point.
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.
Dock(Form, XtraTabbedMdiManager)Moves a floating page from the specified XtraTabbedMdiManager to the current XtraTabbedMdiManager and docks the page.
EndUpdate()Unlocks the XtraTabbedMdiManager object after a call to the BeginUpdate method and causes an immediate visual update.
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.
Float(XtraMdiTabPage, Point)Makes the specified page floating.
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) 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.
GetXtraTabbedMdiManager(Form) staticGets the tabbed MDI manager which is associated with the specified Form.
InitializeLifetimeService()Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
Invalidate()Invalidates the region occupied by the multiple document interface (MDI) client.
Invalidate(Rectangle)Invalidates the specified region occupied by the multiple document interface (MDI) client.
LayoutChanged()Updates a tabbed MDI.
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.

Events

NameDescription
BeginDockingAllows you to cancel docking a floating page onto the XtraTabbedMdiManager.
BeginFloatingAllows you to prevent a page from becoming floating.
CustomDocumentSelectorItemAllows you to customize display settings of the Document Selector’s items.
CustomDocumentSelectorSettingsAllows you to customize the Document Selector’s settings, before it’s displayed on-screen.
CustomDrawHeaderButtonAllows you to draw a header button manually.
CustomDrawTabHeaderAllows you to draw a tab header manually.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
EndDockingFires after a floating page has been docked to the XtraTabbedMdiManager.
EndFloatingFires when dropping a page that is becoming floating.
FloatingFires when a docked page becomes floating.
FloatMDIChildActivatedFires when a floating page is activated.
FloatMDIChildDeactivatedFires when a floating page is deactivated.
FloatMDIChildDraggingFires when dragging a floating page. Allows you to implement the drag-and-drop of child floating pages to another XtraTabbedMdiManager.
MouseDownOccurs when the mouse pointer is over a tabbed MDI and a mouse button is pressed.
MouseEnterOccurs when the mouse pointer enters the tabbed MDI.
MouseLeaveOccurs when the mouse pointer leaves the tabbed MDI.
MouseMoveOccurs when the mouse pointer moves over a tabbed MDI.
MouseUpOccurs when the mouse button is released if it was pressed within a tabbed MDI.
PageAddedFires after a new page has been added to the XtraTabbedMdiManager.Pages collection.
PageRemovedFires after a page has been removed from the XtraTabbedMdiManager.Pages collection.
SelectedPageChangedFires after the selected page has been changed.
SetNextMdiChildProvides the ability to cycle through the pages using custom rules.

See Also

XtraTabbedMdiManager Class

DevExpress.XtraTabbedMdi Namespace