Version

UltraDockManager Class Members

The following tables list the members exposed by UltraDockManager.

Public Constructors
 NameDescription
Public ConstructorUltraDockManager ConstructorOverloaded.   
Public Properties
 NameDescription
Public PropertyActivePaneReturns the DockableControlPane that contains the active control. Read-only.  
Public PropertyAllowDropGets/sets whether the associated dock controls support drag and drop operations.  
Public PropertyAlphaBlendEnabled (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyAlphaBlendMode (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyAnimationEnabledGets/sets whether animations are enabled.  
Public PropertyAnimationSpeedGets/sets the the value determining the speed of the animations  
Public PropertyAppearancesReturns a collection of user created Infragistics.Win.Appearance objects.  
Public PropertyAutoHideDelayGets/sets the delay (in milliseconds) before hiding the flyout control.  
Public PropertyBorderStyleSplitterBarsGets/sets the border style for the splitter bars.  
Public PropertyBorderStyleSplitterBarsResolvedReturns the resolved border style for the splitter bars.  
Public PropertyBorderStyleUnpinnedTabAreaGets/sets the border style for the UnpinnedTabArea.  
Public PropertyBorderStyleUnpinnedTabAreaResolvedReturns the resolved border style for the UnpinnedTabArea  
Public PropertyCanCreateMdiChildFormsIndicates if the dock manager can create mdi child forms for its dockable control panes.  
Public PropertyCaptionButtonAlignmentGets or sets how the caption buttons are aligned within the caption area.  
Public PropertyCaptionButtonStyleGets/sets the style of button used for the pane caption buttons.  
Public PropertyCaptionButtonStyleResolvedReturns the resolved button style for the caption buttons.  
Public PropertyCaptionStyleGets/sets the caption style used when rendering the pane captions.  
Public PropertyCaptionStyleResolvedReturns the resolved caption style used when rendering the pane captions  
Public PropertyComponentRole (Inherited from Infragistics.Win.UltraStylableComponent)
Public PropertyCompressUnpinnedTabsReturns or sets whether the tabs representing the unpinned DockableControlPane objects should be compressed.  
Public PropertyContainer (Inherited from System.ComponentModel.Component)
Public PropertyControlPanesReturns the collection of DockableControlPane instances.  
Public PropertyCreationFilter (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyCursor (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyCursorFilter (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyDefaultGroupSettingsReturns an object specifying the default formating and behavior for pane groups in the component.  
Public PropertyDefaultPaneSettingsReturns an object specifying the default formating and behavior for panes in the component.  
Public PropertyDockAreasReturns a collection of the DockAreaPane instances.  
Public PropertyDragIndicatorStyleGets or sets the style of drag indicator that will be used when dragging panes.  
Public PropertyDragIndicatorStyleResolvedGets the resolved value of the DragIndicatorStyle which is based on the WindowStyle and the current operating system.  
Public PropertyDragWindowColorGets/sets the color used for a translucent drag style window.  
Public PropertyDragWindowOpacityGets/set the opacity percentage used for a translucent drag style window.  
Public PropertyDragWindowStyleGets/sets the how the docked window appears as it is dragged.  
Public PropertyDragWindowStyleResolvedReturns the DragWindowStyle being used by the component.  
Public PropertyDrawFilter (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyEnabled (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyEventManagerThe object that enables, disables and controls firing of UltraDockManager specific events.  
Public PropertyFlatMode (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyFlyoutPaneReturns the DockableControlPane displayed in the flyout window or null if there isn't one displayed.  
Public PropertyHasDefaultGroupSettingsIndicates if a GroupSettings object has been created for the DefaultGroupSettings of the component.  
Public PropertyHasDefaultPaneSettingsIndicates if a PaneSettings object has been created for the DefaultPaneSettings of the component.  
Public PropertyHasNavigatorSettingsIndicates if a NavigatorSettings object has been created for the NavigatorSettings of the component.  
Public PropertyHasSplitterBarAppearanceIndicates whether an Infragistics.Win.AppearanceBase object has been created.  
Public PropertyHasUnpinnedTabAreaAppearanceIndicates whether an Infragistics.Win.AppearanceBase object has been created.  
Public PropertyHideFloatingPanesWhenDeactivatedGets or sets the value which indicates whether the floating panes should hide when the HostControl's Form becomes deactivated.  
Public PropertyHorizontalCaptionGrabHandleWidthReturns or sets the width/thickness of the grab handle in a horizontally orientation pane caption.  
Public PropertyHorizontalCaptionGrabHandleWidthResolvedReturns the resolved HorizontalCaptionGrabHandleWidth used to determine the width of a grab handle in a horizontal oriented pane caption.  
Public PropertyHostControlGets/sets the container that is hosting the docked controls.  
Public PropertyHotTrackingGets/sets whether panes give feedback when the mouse is moved over the caption or tab of a pane.  
Public PropertyImageListGets/sets the ImageList providing the images for the component.  
Public PropertyImageSizeCaptionGets/sets the size of the images used in the caption.  
Public PropertyImageSizeCaptionResolvedReturns the resolved size for the caption images.  
Public PropertyImageSizeTabGets/sets the size of the images used in the pane tab.  
Public PropertyImageSizeTabResolvedReturns the resolved size for the tab images.  
Public PropertyImageTransparentColorGets/sets the color displayed as transparent in a image.  
Public PropertyIsLayoutSuspendedIndicates if the layout has been suspended.  
Public PropertyIsUpdating (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyLastEnteredElementReturns the last element that the mouse entered or null if the mouse is not over any elements.  
Public PropertyLayoutStyleReturns or sets the style used to position the docked DockAreaPane instances  
Public PropertyNavigatorSettingsReturns an object which exposes the settings available on the Navigator user interface.  
Public PropertySaveSettingsIndicates whether this component should automatically save its user configuration settings.  
Public PropertySaveSettingsFormatGets or sets the format in which the user customizations settings will be saved and loaded  
Public PropertyScaleImagesGets/sets when images should be scaled.  
Public PropertySettingsKeyA unique string that distinguishes this UltraDockManager form others in the solution it is being used in. This is needed to store user configuration settings.  
Public PropertyShowCloseButtonGets/sets whether the close button is displayed in the caption of a pane.  
Public PropertyShowDisabledButtonsGets/sets whether disabled caption buttons will be displayed.  
Public PropertyShowFloatingWindowsGets/sets whether the owned floating windows are displayed.  
Public PropertyShowMaximizeButtonGets/sets whether the maximize button is displayed in the caption of a pane.  
Public PropertyShowMenuButtonGets/sets whether the menu button is displayed in the caption of a pane. By default, the menu button will only be displayed if the DockManager's WindowStyle is set to 'VisualStudio2005'.  
Public PropertyShowMenuButtonResolvedGets the resolved value of whether the "menu" button should be shown on the captions of panes or not. If you explicitly set ShowMenuButton then this property will return the value you chose, otherwise it will return a value based on the WindowStyle currently in use by the UltraDockManager.  
Public PropertyShowMinimizeButtonGets/sets whether the minimize button is displayed in the caption of a pane.  
Public PropertyShowPinButtonGets/sets whether the pin button is displayed in the caption of a pane.  
Public PropertyShowToolTipsGets/sets whether tooltips will be displayed for the caption and tabs.  
Public PropertyShowUnpinnedTabAreasGets/sets whether the UnpinnedTabArea is displayed.  
Public PropertyShowUnpinnedTabAreasResolvedReturns the resolved value for the ShowUnpinnedTabAreas  
Public PropertySite (Inherited from System.ComponentModel.Component)
Public PropertySplitterBarAppearanceGets/sets the appearance for the splitter bars.  
Public PropertySplitterBarWidthGets/sets the width of the splitter bars.  
Public PropertyStyleLibraryName (Inherited from Infragistics.Win.UltraStylableComponent)
Public PropertyStyleSetName (Inherited from Infragistics.Win.UltraStylableComponent)
Public PropertySupportThemes (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyTextRenderingMode (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyUnpinnedTabAreaAppearanceGets/sets the appearance for the UnpinnedTabArea.  
Public PropertyUnpinnedTabHoverActionReturns or sets the action that occurs when the mouse hovers over an unpinned tab.  
Public PropertyUnpinnedTabStyleReturns or sets the style of tabs used to represent the unpinned dockable control panes.  
Public PropertyUnpinnedTabStyleResolvedReturns the style used to render the unpinned tabs.  
Public PropertyUseAppStyling (Inherited from Infragistics.Win.UltraStylableComponent)
Public PropertyUseDefaultContextMenusGets/sets whether internal context menus will be displayed for the component.  
Public PropertyUseFlatMode (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyUseFlatModeResolved (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyUseOsThemes (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyUseOsThemesResolved (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyVerticalCaptionGrabHandleHeightReturns or sets the height/thickness of the grab handle in a vertically orientation pane caption.  
Public PropertyVerticalCaptionGrabHandleHeightResolvedReturns the resolved VerticalCaptionGrabHandleHeight used to determine the height of a grab handle in a vertical oriented pane caption.  
Public PropertyVisible (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public PropertyWindowStyleGets/sets the window style used when rendering the dockable windows.  
Public PropertyWindowStyleResolvedReturns the resolved WindowStyle  
Protected Properties
 NameDescription
Protected PropertyCanRaiseEvents (Inherited from System.ComponentModel.Component)
Protected PropertyDesignMode (Inherited from System.ComponentModel.Component)
Protected PropertyEvents (Inherited from Infragistics.Win.UltraComponentBase)
Protected PropertySubObjectPropChangeHandlerReturns the event handler that notifies OnSubObjectPropChanged  
Public Methods
 NameDescription
Public MethodBeginUpdate (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodDisposeOverloaded. Overridden. Releases the unmanaged resources used by the System.ComponentModel.Component and optionally releases the managed resources.  
Public MethodDockControlsCreates a new dock area and new DockableControlPane instances for the specified controls.  
Public MethodElementFromPointReturns the UIElement at the point specified.  
Public MethodEndUpdateOverloaded.  (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public MethodFlyInOverloaded. Hides the current flyout DockableControlPane  
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodHideAllHides all visible panes  
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodLoadComponentSettingsLoads the user configuration settings for this component.  
Public MethodLoadFromBinaryOverloaded. Loads the docked window information from the specified stream containing a serialized UltraDockManager using the SaveAsBinary(Stream) method.  
Public MethodLoadFromXMLOverloaded. Loads the docked window information from the specified stream containing a serialized UltraDockManager using the SaveAsXML(Stream) method.  
Public MethodPaneFromControlReturns the DockableControlPane which contains the specified control.  
Public MethodPaneFromKeyReturns the pane with the specified key.  
Public MethodPaneFromPositionOverloaded. Returns the pane at the specified position.  
Public MethodPinAllPins all visible, unpinned DockableControlPane instances  
Public MethodResetComponentSettingsResets the user configuration settings for this component.  
Public MethodResetControlPanesResets the ControlPanes property to its default value.  
Public MethodResetCursor (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public MethodResetDefaultGroupSettingsResets the DefaultGroupSettings property to its default value.  
Public MethodResetDefaultPaneSettingsResets the DefaultPaneSettings property to its default value.  
Public MethodResetDragWindowColorResets the DragWindowColor property to its default value.  
Public MethodResetImageSizeCaptionResets the ImageSizeCaption property to its default value.  
Public MethodResetImageSizeTabResets the ImageSizeTab property to its default value.  
Public MethodResetImageTransparentColorResets the ImageTransparentColor property to its default value.  
Public MethodResetNavigatorSettingsResets the NavigatorSettings property to its default value.  
Public MethodResetSplitterBarAppearanceResets the SplitterBarAppearance property to its default value.  
Public MethodResetUnpinnedTabAreaAppearanceResets the UnpinnedTabAreaAppearance property to its default value.  
Public MethodResumeLayoutReenables the layout manager causing the control to recalculate the pane sizes.  
Public MethodSaveAsBinaryOverloaded. Saves the docked window information into the specified stream as binary data.  
Public MethodSaveAsXMLOverloaded. Saves the docked window information into the specified stream as xml/soap data.  
Public MethodSaveComponentSettingsSaves the user configuration settings for this component.  
Public MethodShowAllOverloaded. Shows all hidden panes  
Public MethodShowNavigatorDisplays the Navigator user interface.  
Public MethodSuspendLayoutPrevents the layout manager from changing the size of panes.  
Public MethodToString (Inherited from System.ComponentModel.Component)
Public MethodUnpinAllUnpins all visible, pinned DockableControlPane instances  
Public MethodValidateChildrenOverloaded. Invokes the ValidateChildren of the HostControl or WindowDockingAreas that represent the dock areas. See ContainerControl.ValidateChildren for details about the ValidationConstraints and ValidateChildren method.  
Protected Methods
 NameDescription
Protected MethodChangeControlsEnabledStateOverridden. Toggles the enabled state of the managed controls  
Protected MethodChangeControlsVisibleStateOverridden. Toggles the visible state of the managed controls  
Protected MethodCreateComponentRoleOverridden. Factory method used to create the component role that provides the style information for the control.  
Protected MethodDirtyChildElementsOverridden. Dirties the control uielements associated with the managed controls.  
Protected MethodFinalize (Inherited from System.ComponentModel.Component)
Protected MethodGetObjectDataInvoked during the serialization of the object.  
Protected MethodGetSelectionManager (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Protected MethodGetService (Inherited from System.ComponentModel.Component)
Protected MethodInitializeFloatingWindowContainerGets called when a floating window is being initialized to host a dock area pane which has just been floated.  
Protected MethodInitializeFromUsed during deserialization to initialize the component with the properties of the serialized UltraDockManager component  
Protected MethodInvalidateControlsOverridden. Invalidates the control uielements associated with the managed controls.  
Protected MethodIsPaneOnActiveWindowGets the value which indicates whether the specified pane is on the active window.  
Protected MethodManagedControlInitializedOverridden. Invoked when an UnpinnedTabArea, AutoHideControl or DockedWindowArea control is initialized.  
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodNotifyPropChangeOverloaded.  (Inherited from Infragistics.Win.UltraComponentBase)
Protected MethodOnAfterDockChangeRaises the AfterDockChange event when a pane drag operation is completed.  
Protected MethodOnAfterHideFlyoutRaises the AfterHideFlyout event when an unpinned DockableControlPane is hidden  
Protected MethodOnAfterNavigatorClosedRaises the AfterNavigatorClosed event after the Navigator user interface has been closed.  
Protected MethodOnAfterPaneButtonClickRaises the AfterPaneButtonClick event after the action associated with a pane caption's button is executed.  
Protected MethodOnAfterSplitterDragRaises the AfterSplitterDrag event after a splitter bar has been repositioned.  
Protected MethodOnAfterToggleDockStateRaises the AfterToggleDockState event after a pane's DockedState has been changed from docked to floating or vice versa.  
Protected MethodOnBeforeDockChangeRaises the BeforeDockChange event as a docked window is being dragged.  
Protected MethodOnBeforeDockChangeStartRaises the BeforeDockChangeStart event before a drag of a pane begins.  
Protected MethodOnBeforeNavigatorDisplayedRaises the BeforeNavigatorDisplayed event before the Navigator user interface is displayed.  
Protected MethodOnBeforePaneButtonClickRaises the BeforePaneButtonClick event before the action associated with a pane caption's button is executed.  
Protected MethodOnBeforeShowFlyoutRaises the BeforeShowFlyout event when an unpinned DockableControlPane is about to be displayed.  
Protected MethodOnBeforeSplitterDragRaises the BeforeSplitterDrag event before a splitter bar is repositioned.  
Protected MethodOnBeforeToggleDockStateRaises the BeforeToggleDockState event before a pane's docked state is toggled.  
Protected MethodOnBeginInitInvoked during the System.ComponentModel.ISupportInitialize.BeginInit of the component.  
Protected MethodOnDeserializationInvoked after the entire object graph has been deserialized.  
Protected MethodOnDoubleClickSplitterBarRaises the DoubleClickSplitterBar event when a splitter bar has been double clicked.  
Protected MethodOnEndInitInvoked during the System.ComponentModel.ISupportInitialize.EndInit of the component.  
Protected MethodOnInitializeNavigatorItemRaises the InitializeNavigatorItem event for an item in the Navigator user interface.  
Protected MethodOnInitializeNavigatorItemDescriptionRaises the InitializeNavigatorItemDescription event for an item in the Navigator user interface, the first time it is selected.  
Protected MethodOnInitializePaneRaises the InitializePane event when a DockablePaneBase is created.  
Protected MethodOnLayoutLoadedCalled after a layout file is loaded with one of the LoadFromBinary or LoadFromXML overloads.  
Protected MethodOnMouseEnterElementOverridden. Raises the Infragistics.Win.UltraComponentControlManagerBase.MouseEnterElement event when the mouse is moved over a UIElement.  
Protected MethodOnMouseLeaveElementOverridden. Raises the Infragistics.Win.UltraComponentControlManagerBase.MouseLeaveElement event when the mouse is moved out of a UIElement.  
Protected MethodOnPaneActivateRaises the PaneActivate event when a DockableControlPane contains the active control.  
Protected MethodOnPaneDeactivateRaises the PaneDeactivate event when a DockableControlPane no longer contains the active control.  
Protected MethodOnPaneDisplayedRaises the PaneDisplayed event when a DockableControlPane is brought into view.  
Protected MethodOnPaneHiddenRaises the PaneHidden event when a DockableControlPane is hidden from view.  
Protected MethodOnPropertyChangedOverridden. Invoked when a property on the component or subobject of the component has changed.  
Protected MethodOnSubObjectPropChangedCalled when a property on a sub object has changed.  
Protected MethodShouldSerializeControlPanes

Returns a Boolean value that determines whether the ControlPanes property is set to its default value.

 
Protected MethodShouldSerializeCursor (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Protected MethodShouldSerializeDefaultGroupSettings

Returns a Boolean value that determines whether the DefaultGroupSettings property is set to its default value.

 
Protected MethodShouldSerializeDefaultPaneSettings

Returns a Boolean value that determines whether the DefaultPaneSettings property is set to its default value.

 
Protected MethodShouldSerializeDockAreas

Returns a Boolean value that determines whether the DockAreas property is set to its default value.

 
Protected MethodShouldSerializeDragWindowColor

Returns a Boolean value that determines whether the DragWindowColor property is set to its default value.

 
Protected MethodShouldSerializeImageSizeCaption

Returns a Boolean value that determines whether the ImageSizeCaption property is set to its default value.

 
Protected MethodShouldSerializeImageSizeTab

Returns a Boolean value that determines whether the ImageSizeTab property is set to its default value.

 
Protected MethodShouldSerializeImageTransparentColor

Returns a Boolean value that determines whether the ImageTransparentColor property is set to its default value.

 
Protected MethodShouldSerializeNavigatorSettings

Returns a Boolean value that determines whether the NavigatorSettings property is set to its default value.

 
Protected MethodShouldSerializeSplitterBarAppearanceIndicates whether the SplitterBarAppearance property contains data that needs to be serialized.  
Protected MethodShouldSerializeUnpinnedTabAreaAppearanceIndicates whether the UnpinnedTabAreaAppearance property contains data that needs to be serialized.  
Public Events
 NameDescription
Public EventAfterDockChangeOccurs after the dock status of a pane has changed.  
Public EventAfterHideFlyoutOccurs when an unpinned DockableControlPane is hidden.  
Public EventAfterNavigatorClosedFires after the Navigator user interface is closed.  
Public EventAfterPaneButtonClickOccurs after the action associated with a PaneButton is executed.  
Public EventAfterSplitterDragOccurs after the splitter bar for a pane is released.  
Public EventAfterToggleDockStateOccurs after a pane's dock state is toggled from Docked to Floating or vice versa.  
Public EventBeforeDockChangeOccurs as a dockable pane is dragged.  
Public EventBeforeDockChangeStartOccurs before a dockable pane drag begins.  
Public EventBeforeNavigatorDisplayedFires before the Navigator user interface is displayed.  
Public EventBeforePaneButtonClickOccurs before the action associated with a PaneButton is executed.  
Public EventBeforeShowFlyoutOccurs when the flyout is about to be displayed.  
Public EventBeforeSplitterDragOccurs before a splitter drag begins.  
Public EventBeforeToggleDockStateOccurs before a pane's dock state is toggled from Docked to Floating or vice versa.  
Public EventDisposed (Inherited from System.ComponentModel.Component)
Public EventDoubleClickSplitterBarOccurs when the user double clicks on a splitter bar.  
Public EventInitializeNavigatorItemFires once for each list item that appears in the Navigator user interface.  
Public EventInitializeNavigatorItemDescriptionFires once for each list item that appears in the Navigator user interface, once that item has been selected. This event does not fire if the ShowDescriptionArea property is false.  
Public EventInitializePaneOccurs when a DockablePaneBase is created.  
Public EventMouseEnterElement (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public EventMouseLeaveElement (Inherited from Infragistics.Win.UltraComponentControlManagerBase)
Public EventPaneActivateOccurs when the control contained within a DockableControlPane is activated.  
Public EventPaneDeactivateOccurs when the control contained within a DockableControlPane is deactivated.  
Public EventPaneDisplayedOccurs when a DockableControlPane is brought into view.  
Public EventPaneHiddenOccurs when a DockableControlPane is take out of view.  
Public EventPropertyChanged (Inherited from Infragistics.Win.UltraComponentBase)
See Also