DockingOptions Members

Provides docking options that are common to all dock panels.

Constructors

Name Description
DockingOptions() Initializes a new instance of the DockingOptions class.
DockingOptions(DockManager) Initializes a new instance of the DockingOptions class with the specified settings.

Properties

Name Description
AllowDockToCenter Gets or sets whether or not panels can dock to the middle of the DockManager's parent container (Form or UserControl).
AllowRestoreToAutoHideContainer Gets or sets whether or not dock panels that have been dragged away from their parent auto-hide containers should return to these containers when docked again.
AutoHidePanelVerticalTextOrientation Specifies the vertical direction of auto-hidden panel captions.
CloseActiveFloatTabOnly Gets or sets whether only a dock panel corresponding to the active tab within a floating container can be closed upon clicking the close button.
CloseActiveTabOnly Gets or sets whether only the dock panel corresponding to the currently active tab in a tab container is closed when the close button within the tab container's caption is clicked. The option is not in effect when the tab container is in the floating state.
CursorFloatCanceled Gets or sets the cursor that indicates that a dock panel cannot be floating during a dock operation.
CustomResizeZoneThickness Gets or sets the thickness of a resize zone for any dock panel owned by this manager.
DockPanelInCaptionRegion Gets or sets whether a panel can be docked as a tab to another panel while dragging over its header.
DockPanelInTabContainerTabRegion Gets or sets whether the panel is immediately docked while dragging over the tab region or the panel is docked when it is dropped.
FloatOnDblClick Gets or sets whether an end-user can double-click a panel's caption to float it. Inherited from BaseDockOptions.
FloatPanelsAlwaysOnTop Gets or sets whether floating DockManager panels are always drawn on top of their parent forms.
HideImmediatelyOnAutoHide Gets or sets whether a panel hides immediately (without animation) when the user unpins the panel.
HidePanelsImmediately Gets or sets whether a panel hides immediately (without animation) when the user unpins the panel and whether a panel hides immediately when it loses the focus.
ShowAutoHideButton Gets or sets whether the auto hide button is displayed within a dock panel's caption. Inherited from BaseDockOptions.
ShowCaptionImage Gets or sets whether an image associated with a dock panel is displayed within the panel's caption.
ShowCaptionOnMouseHover Gets or sets whether the dock panel's caption is shown only when the mouse pointer hovers over the panel's top or all the time.
ShowCloseButton Gets or sets whether the close button is displayed within a dock panel's caption. Inherited from BaseDockOptions.
ShowMaximizeButton Gets or sets whether the maximize button can be displayed within a dock panel's caption. Inherited from BaseDockOptions.
ShowMinimizeButton Gets or sets whether floating Dock Panels should display buttons that allow users to collapse (minimize) these panels. Mimimize buttons cannot be shown if panels are always on top of their parent forms (see the DockingOptions.FloatPanelsAlwaysOnTop property). Inherited from BaseDockOptions.
SnapMode Gets or sets whether or not dock panels can stick to each other, parent forms or screen edges.
TabbedPanelVerticalTextOrientation Gets or sets the text direction, according to which tabbed panels' header strings are drawn.

Methods

Name Description
Assign(BaseOptions) Copies all the settings from the options object passed as the parameter.
BeginUpdate() Locks the BaseOptions object by disallowing visual updates until the EndUpdate or CancelUpdate method is called. Inherited from BaseOptions.
CancelUpdate() Unlocks the BaseOptions object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from BaseOptions.
EndUpdate() Unlocks the BaseOptions object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from BaseOptions.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Reset() Resets all options to their default values. Inherited from BaseOptions.
ToString() Returns a string representing the currently enabled options. Inherited from BaseOptions.
See Also