Child elements are positioned according to the state of the pane containing them, taking into account factor such as whether the pane is pinned and flown out or collapesed, and the positions of any splitter bars between child panes.
This method also returns the initial rects for the vertical and horizontal bars that will need to be inverted during a mouse drag operation.
This method applies the changes to a splitter bar that result from a resizing or movement of the pane.
The DockableControlPane is the pane container for a dockable control. The
Control panes may be "unpinned". Unpinning a pane results in the pane no longer appearing within the bounds
of its
To determine whether a control pane is currently unpinned, use the
Only docked control panes may be unpinned.
The DockablePaneBase class implements the common functionality for all pane objects. Pane objects
are the basic container class used by the
The
The
The class implements methods for changing where a pane is docked. The
Invoking this method is the equivalent of clicking the "X" button in the pane's caption area.
Invoking this method is the equivalent of clicking the "X" button in the pane's caption area.
Invoking this method is equivalent to double-clicking on teh pane's title bar.
You can specify whether the pane should be docked at the top, bottom, left or right side of the client area.
The maintainPreviousState parameter is used to determine how grouped floating panes should be re-docked. You can take panes from multiple docking areas and group them together in one floating pane group. You can then dock that floating group. When maintainPreviousState is set to True, the previous dock state of each pane is preserved, and docking the group will cause all of its panes to re-dock at their origninal locations. You can force the panes to remain together (and possibly change their docking location) when the floating group is docked by specifying False for the maintainPreviousState parameter.
If you invoke this method for a floating pane that has never been docked, the pane will dock along the right side of the client area.
If the pane has previously floated, it will return to its former location. If the pane has never floated, a new floating window will be created for it. To specify what should occur when the pane is floated, use one of the overloads of this method.
You can specify whehter the pane should return to its previous floating location (if any) or if it should be placed in a new floating window.
This method cannot be invoked on a floating DockArea pane.
This method cannot be invoked on a floating DockArea pane.
This method examines the settings and relationship of two panes and determines whether the one pane can act as a parent for the other.
All panes are either immediately or ultimately contained by a DockArea pane. This property returns a reference to that pane, regardless of any other panes the current pane may be nested inside of.
This property returns null if the pane does not have a parent.
You can use this property to set a minimum height and/or width for the pane. Note that there may be other factors that contribute to the minimum size of the pane, such as the minimum size limits placed on any child panes and the space required for margins, captions, buttons, etc.
You can specify a maximum height and/or width that the pane should not exceed during resizing.
This property takes into account whether the pane is a sliding group or a tab group pane.
This property returns either DockedState.Docked or DockedState.Floating, depending on the current condition of the pane.
When panes are closed they are hidden and this property will return False.
Set this property to True to maximize the pane.
This property takes into account whether the pane is a sliding group or a tab group pane.
Set this property to True to minimize the pane.
This property specifies how deeply nested the pane is within other panes. For top-level (DockArea) panes, NestDepth returns 0. A pane nested inside a top-level pane will return 1.
Even when a pane is floating in a window, it maintains a relationship with the pane to which it was previously docked. It will return to the dock area to which it was previously parented when it is re-docked (through code or by double-clicking on the pane's title bar.) While docked, the pane also maintains its relationship with the window in which it was previously floating.
Even when a pane is docked, it maintains a relationship with the pane in which it was previously floated. It will return to the floating pane in which it was previously displayed when it is re-floated (through code or by double-clicking on the pane's title bar.) While floating, the pane also maintains its relationship with the window in which it was previously docked.
Panes are pinned and unpinned using the "pin" button that appears in the tilte bar of the pane, beside the close button.
When panes are pinned, they automatically collapse to the edge of the container when not in use. Pinned panes are accessible via the tabbed interface bar that appears along the edge where the pane was pinned. Mousing over or clicking on the tab for the pane causes it to fly out and become accessible.
This size value does not necessarily equal the size actually used to display the pane. The
it is neccesary to maintain two different size settings for each pane because of the way pane sizes are adjusted when one or more panes are hidden or pinned. For example, suppose there are two panes occupying a specific dock area and that the first one is one-third the width of the available space, with the second occupying the remaining two-thirds. If the second pane is hidden, the first (narrower) pane expands to fill the available space. Now suppose the second pane is unhidden. If the original size of each pane were not preserved in some way, there would be no way to restore the original proportions of the panes.
To solve this problem, the size of each pane is stored in two places. The Size property records the size of the pane and its proportion to other panes in a docking area. This information is preserved if the pane is hidden. It is only changed when the pane is resized. The DisplaySize property is used to indicate the actual size of a pane at any given time. Each time the pane changes size on the screen, the value of DisplaySize changes.
Note that the pane size preserved by the Size property is used to determine size ratios, and may or may not be used for the actual size of the pane. Continuing the example above, suppose that after the pane is hidden, the docking area is resized to half its width. When the pane is unhidden, the Size property is used to restore the original 1/3 to 2/3 proportions of the panes, although neither pane will be returned to the actual dimensions used when the two panes were originally displayed.
The DisplaySize property indicates the size at which the pane is currently displayed. The ratio of the
It is necesary to maintain two different size settings for each pane because of the way pane sizes are adjusted when one or more panes are hidden or pinned. For example, suppose there are two panes occupying a specific dock area and that the first one is one-third the width of the available space, with the second occupying the remaining two-thirds. If the second pane is hidden, the first (narrower) pane expands to fill the available space. Now suppose the second pane is unhidden. If the original size of each pane were not preserved in some way, there would be no way to restore the original proportions of the panes.
To solve this problem, the size of each pane is stored in two places. The
Invoking this method causes the pane to flyout from the tab area, just as if the user had passed the mouse pointer over the pane's tab.
Invoking this method causes the pane to flyout from the tab area, just as if the user had passed the mouse pointer over the pane's tab.
Invoking this method causes the pane to flyout from the tab area, just as if the user had passed the mouse pointer over the pane's tab.
Invoking this method is equivalent to the user clicking the pin button in the pane's caption area when the pane is unpinned. The pane will become pinned to the dock area, and can no longer be collapsed. If the pane is currently collapsed into the UnpinnedTabArea, it will immediately fly out and become visible. Its tab will be removed from the UnpinnedTabArea, and if there are no other tabs there, the UnpinnedTabArea will be hidden.
When a pane is unpinned, its contents are displayed only while in use. At other times, the pane collapses into a tab at the edge of the docking area (the UnpinnedTabArea). The user may display the pane by clicking or hovering over the tab. Moving the mouse over the tab causes the pane to fly out; clicking the tab causes the pane to fly out and become activated.
Invoking this method is equivalent to the user clicking the unpin button in the pane's caption area when the pane is pinned. The UnpinnedTabArea will be displayed if it is not already showing. If the pane is active when it is pinned, it will immediately fly out and become visible.
This property returns False when the pane is collapsed into the tab area.
When a pane is pinned, its contents are displayed only while in use. At other times, the pane collapses into a tab at the edge of the docking area (the UnpinnedTabArea). The user may display the pane by clicking or hovering over the tab. Moving the mouse over the tab causes the pane to fly out; clicking the tab causes the pane to fly out and become activated.
The class contains all the
If the specified control is not found on any of the panes in the collection, no action is taken.
This property always returns False for the DockableControlPanes collection.
The DockableGroupPane is a container for
The
The
Use this method to return visible panes in a sequence from first to last. To determine which visible pane is first in a group, use the
Use this method to return visible panes in a sequence from last to first. To determine which visible pane is last in a group, use the
When a pane is pinned, its contents are displayed only while in use. At other times, the pane collapses into a tab at the edge of the docking area (the UnpinnedTabArea). The user may display the pane by clicking or hovering over the tab. Moving the mouse over the tab causes the pane to fly out; clicking the tab causes the pane to fly out and become activated.
Invoking this method pins all of the panes within a DockableGroupPane at once. The panes will become pinned to the dock area, and the UnpinnedTabArea will be displayed if it is not already showing. If one of the panes is active when it is pinned, it will immediately fly out and become visible. Note that the setting of
Invoking this method unpins all of the panes in the group. The panes will become unpinned from the dock area, and can no longer be collapsed. If any pane is currently collapsed into the UnpinnedTabArea, it will immediately fly out and become visible. All tabs will be removed from the UnpinnedTabArea and the UnpinnedTabArea will be hidden.
This method will examine each child pane in the group to determine whehter it is hidden. If so, the pane will be displayed. This has the effect of re-opening any panes that may have been closed by the user.
This method will examine each child pane in the group to determine whehter it is hidden. If so, the pane will be displayed. This has the effect of re-opening any panes that may have been closed by the user.
You can specify whether the panes that are shown should be pinned. Pinning the unhidden panes makes them available to the user but does not immediately display them and alter the layout of panes in the group. (Unexpectedly altering the group's layout of visible panes has the potential to confuse the user. By pinning the unhidden panes, only the UnpinnedTabArea changes appearance.)
Use this method to determine if a specific pane is located anywhere within a group. This method iterates through the panes of the group looking for a match with the pane specified. You can specify whether this method should search recursively to find nested panes, or simply examine top-level panes when searching.
This property returns the first visible pane or null if there are no visible panes. You can use this property in conjunction with the
This property returns the last visible pane or null if there are no visible panes. You can use this property in conjunction with the
The settings of the group contained by the
The available styles for the child panes include horizontal split, vertical split, tab group and sliding group. The setting for this property applies to all the panes in the dock area.
The horizontal split and vertical split styles simply divide the panes horizontally or vertically. Panes are either arranged from top to bottom or side-by-side, respectively. The TabGroup style causes all panes to occupy the full area of the DockableGroupPane, with tabs appearing at the bottom of the pane to enable the user to select each pane. SlidingGroup style arranges the panes in an interface similar to the Outlook bar; each pane occupies the full area of the DoockableGroupPane, and individual panes are selected by clicking on button-style headers.
A
The collection represents a group of sibling panes. The order of the items in
the collection determine the position of the pane when displayed by the
Because the DockableWindowPlaceholder is non-visual and only serves to hold the position of a DockableWindow, this property always returns False.
The DockAreaPane is a specialized
The
A DockAreaPane pane cannot be contained by any other pane.
This property specifies a
The minimum size of a pane may be limited by the presence of child panes and the need to display captions and respect minimum settings on those panes. This property returns the actual value in effect that determines the pane's minimum size. If a pane does not have child panes, its minimum size is 20 x 20.
When the
The index of
This property always returns False for the DockAreas collection.
The EventManager is used to selectively enable and disable events for the control.
To determine if a specific event is processing its event code at the current point in time, use the InProgress method. You should always check whehter and event is processing before disabling it.
Caution Do not disable an event before it has finished processing. Disabling an event while it is still processing can produce unpredictable results.
The EventManager is used to selectively enable and disable events for the control. This method will return True if the specified event is enabled and the code in the event's procedure will be executed when the appropriate circumstances arise. If this method returns False, the event is disabled and code entered in the event procedure will not be executed.
The EventManager is used to selectively enable and disable events for the control. You can use this method to enable or disable any event in the control by specifying the event's unique ID and the state you want the event to be set to.
Caution Do not disable an event before it has finished processing. Disabling an event while it is still processing can produce unpredictable results. You should use the
The EventManager is used to selectively enable and disable events for the control. This method will return True if the events in a group are enabled and the code in the events' procedures will be executed when the appropriate circumstances arise. If this method returns False, at least one event in the group is disabled.
UltraDockManager events are categorized into groups to simplify the enabling and disabling of blocks of related events.
The EventManager is used to selectively enable and disable events for the control. UltraDockManager events are categorized into groups to simplify the enabling and disabling of blocks of related events. This method lets you set the enabled state for all of the events in a group at one time.
Caution Do not disable an event before it has finished processing. Disabling an event while it is still processing can produce unpredictable results. You should use the
This method returns True if the point is inside the adjustable area, False if it is outside.
This property always returns True for this type of object.
This property returns a value specifying the type of border to use, as defined in the
The GroupSettings object is used to affect the appearance and behavior of
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
The possible settings for CaptionLocation include top, bottom, left and right.
Depending on the setting of this property, clicking the close button for a pane in a tab group will either close the entire group's panes or only the pane that was selected when the button was clicked.
Depending on the setting of this property, clicking the pin button for a pane in a tab group will either pin the entire group's panes or only the pane that was selected when the button was clicked.
Use this property to select at
Sliding groups can appear with a horizontal or vertical orientation.
Use this property to determine if an
Possible settings are top, bottom left and right. Tabs will appear along the specified edge of the group's pane.
The tabs that appear in the Tab Group can be automatically sized according to the context of your application. The TabSizing property specifies how the control will adjust the size of the tabs. You can specify a fixed or variable size for tabs, have tabs adjust their size based on caption and picture or the amount of space available, and have inactive tabs display as an icon without a caption to save space.
A variety of tab styles ara available for the tabs that appear in the Tab Group. You can use this property to specify whether the tabs should appear in a manner that is consistent with Office XP, Visual Studio .NET, or other interface styles.
All of the properties of the
This property always returns the value that is in effect for the control. The possible settings for CaptionLocationResolved include top, bottom, left and right.
This property always returns the value that is in effect for the control. Depending on the setting of this property, clicking the close button for a pane in a tab group will either close the entire group's panes or only the pane that was selected when the button was clicked.
This property always returns the value that is in effect for the control. Depending on the setting of this property, clicking the pin button for a pane in a tab group will either pin the entire group's panes or only the pane that was selected when the button was clicked.
This property always returns the value that is in effect for the control. Use this property to determine which
This property always returns the value that is in effect for the control. Possible settings are top, bottom left and right. Tabs will appear along the specified edge of the group's pane.
The tabs that appear in the Tab Group can be automatically sized according to the context of your application. The TabSizing property specifies how the control will adjust the size of the tabs. This property always returns the value that is in effect for the control.
You can specify a fixed or variable size for tabs, have tabs adjust their size based on caption and picture or the amount of space available, and have inactive tabs display as an icon without a caption to save space.
A variety of tab styles are available for the tabs that appear in the Tab Group. You can use this property to specify whether the tabs should appear in a manner that is consistent with Office XP, Visual Studio .NET, or other interface styles.
Invoke this method to reset the
Once this method is invoked, the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
The Navigator feature of the
The NavigatorSettings class contains properties that provide fine-grained control over various settings used by
the Navigator user interface. For example, the
The
The UltraDockManager has several Navigator-related events that can be used to customize the runtime behavior of the Navigator feature:
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an FooterAreaAppearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an HeaderAreaAppearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an HotTrackedItemAreaAppearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Note: Control panes which have never been displayed since the creation of the UltraDockManager will not show a preview.
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
This property returns a value specifying the type of button style to use, as defined in the
This property returns a value specifying the type of border to use, as defined in the
The PaneSettings object is used to affect the appearance and behavior of
The allow properties (e.g.
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
Use this property to determine if an
This property determines whether a pin button will be displayed in the pane's title bar. The user can click this button to pin or unpin the pane.
When a pane is unpinned, its contents are displayed only while in use. At other times, the pane collapses into a tab at the edge of the docking area (the UnpinnedTabArea). The user may display the pane by clicking or hovering over the tab. Moving the mouse over the tab causes the pane to fly out; clicking the tab causes the pane to fly out and become activated.
If the pane is draggable, it may be repositioned to other docking areas or floated in its own window. Set this property to False to lock the pane into the docking area set up by the developer.
You can use this property to restrict the areas that a pane may be docked. One common usage would be to specify specific panes that can only dock horizontally or vertically.
You can use this property to restrict the areas that a pane may be docked. One common usage would be to specify specific panes that can only dock horizontally or vertically.
You can use this property to restrict the areas that a pane may be docked. One common usage would be to specify specific panes that can only dock horizontally or vertically.
You can use this property to restrict the areas that a pane may be docked. One common usage would be to specify specific panes that can only dock horizontally or vertically.
The close button is displayed in a pane's caption area. Clicking the button hides the pane. When this property is set to False, the pane cannot be hidden (closed) except through code.
If this property is set to False, the pane may only be docked to the container area. The user can still move the pane to a different edge for docking.
For the maximize button to be visible on any pane, the
The AllowMaximize property determines whether a pane can be maximized within a group. In order for a pane to be maximized, it must be in a group with at least one other pane, and the group cannot be a tabbed or sliding group. When a pane is maximized, all other panes in the group are reduced to their minimum size, showing only the title bar. (Note that this is not the same as being minimized.) Only one pane in a group may be maximized at one time. If a pane is maximized, and the user maximizes a second pane, the first pane is automatically restored.
How other panes in a group are resized to accommodate a maximized pane varies depending on whether the group is split horizontally or vertically. A horizontally split group will maximize the height of the maximized pane. Other panes will be reduced to a title bar above or below the maximized pane. If the group is vertically split, the width of the pane will be maximized, with the title bars of other panes appearing to the left or right of the maximized pane.
Typically, you will not make use of maximizing and minimizing of panes in the same group at the same time. Because of the requirement that one pane must fill the group area at all times, minimization and maximization do not behave exactly as they do for other windows. Therefore, you risk confusing the user of your application by providing both functions simultaneously.
For the minimize button to be visible on any pane, the
The AllowMinimize property determines whether a pane can be minimized within a group. In order for a pane to be minimized, it must be in a group with at least one other pane, and the group cannot be a tabbed or sliding group. Minimizing a pane toggles its minimized state, which it maintains until you have restored it. When the minimized state is active, the pane will be minimzed if it is possible to do so. In a pane group, one pane must always be available to fill the area of the pane, so it is not possible for all panes to be minimized simultaneously. One pane will always fill the pane area, even it its minimized state must be ignored to do so. Also, note that a pane can be simultaneously minimized and maximized. The minimzed state will take precedence over the maximized state.
How other panes in a group are resized to accommodate a minimized pane varies depending on whether the group is split horizontally or vertically. A horizontally split group will reduce the minimized pane to a title bar above or below the other panes. If the group is vertically split, the title bars of the pane will appear to the left or right of the other panes. Note that the caption of the pane will be rotated when it is minimized in a vertically split group.
Typically, you will not make use of maximizing and minimizing of panes in the same group at the same time. Because of the requirement that one pane must fill the group area at all times, minimization and maximization do not behave exactly as they do for other windows. Therefore, you risk confusing the user of your application by providing both functions simultaneously.
Set this property to False to prevent the user from resizing a pane by dragging its edges.
Set this property to False to prevent the user from changing the 'IsMdiChild' state of the control pane.
Set this property to False to prevent the user from dragging the pane over the caption of another pane thereby creating a new tab group.
This property specifies the amount of blank space that will appear beween the contents of the pane and the pane's left edge.
This property specifies the amount of blank space that will appear beween the contents of the pane and the pane's right edge.
This property specifies the amount of blank space that will appear beween the contents of the pane and the pane's top edge.
This property specifies the amount of blank space that will appear beween the contents of the pane and the pane's bottom edge.
By default when double clicking on the caption, tab or sliding group element of a pane, its state is toggled. If the pane was docked, the pane and any descendants are returned to their previous floating positions. If the pane was floating, the pane and any descendants are returned to their previous docked positions.
By default, the presence and type of the grab handle is based on the resolved
All of the properties of the
This property always returns the value that is in effect for the control. This property determines whether a pin button will be displayed in the pane's title bar. The user can click this button to pin or unpin the pane.
When a pane is unpinned, its contents are displayed only while in use. At other times, the pane collapses into a tab at the edge of the docking area (the UnpinnedTabArea). The user may display the pane by clicking or hovering over the tab. Moving the mouse over the tab causes the pane to fly out; clicking the tab causes the pane to fly out and become activated.
This property always returns the value that is in effect for the control. If the pane is draggable, it may be repositioned to other docking areas or floated in its own window. If this property is set to False to lock the pane into the docking area set up by the developer.
This property always returns the value that is in effect for the control. This property is used to restrict the areas that a pane may be docked. One common usage would be to specify specific panes that can only dock horizontally or vertically.
This property always returns the value that is in effect for the control. This property is used to restrict the areas that a pane may be docked. One common usage would be to specify specific panes that can only dock horizontally or vertically.
This property always returns the value that is in effect for the control. This property is used to restrict the areas that a pane may be docked. One common usage would be to specify specific panes that can only dock horizontally or vertically.
This property always returns the value that is in effect for the control. This property is used to restrict the areas that a pane may be docked. One common usage would be to specify specific panes that can only dock horizontally or vertically.
This property always returns the value that is in effect for the control. The close button is displayed in a pane's caption area. Clicking the button hides the pane. When this property is set to False, the pane cannot be hidden (closed) except through code.
This property always returns the value that is in effect for the control. If this property is set to False, the pane may only be docked to the container area. The user can still move the pane to a different edge for docking.
For the maximize button to be visible on any pane, the
The AllowMaximize property determines whether a pane can be maximized within a group. This property always returns the value that is in effect for the control.
In order for a pane to be maximized, it must be in a group with at least one other pane, and the group cannot be a tabbed group. When a pane is maximized, all other panes in the group are reduced to their minimum size, showing only the title bar. (Note that this is not the same as being minimized.) Only one pane in a group may be maximized at one time. If a pane is maximized, and the user maximizes a second pane, the first pane is automatically restored.
How other panes in a group are resized to accommodate a maximized pane varies depending on whether the group is split horizontally or vertically. A horizontally split group will maximize the height of the maximized pane. Other panes will be reduced to a title bar above or below the maximized pane. If the group is vertically split, the width of the pane will be maximized, with the title bars of other panes appearing to the left or right of the maximized pane.
Typically, you will not make use of maximizing and minimizing of panes in the same group at the same time. Because of the requirement that one pane must fill the group area at all times, minimization and maximization do not behave exactly as they do for other windows. Therefore, you risk confusing the user of your application by providing both functions simultaneously.
For the minimize button to be visible on any pane, the
The AllowMinimize property determines whether a pane can be minimized within a group. This property always returns the value that is in effect for the control.
In order for a pane to be minimized, it must be in a group with at least one other pane, and the group cannot be a tabbed group. Minimizing a pane toggles its minimized state, which it maintains until you have restored it. When the minimized state is active, the pane will be minimzed if it is possible to do so. In a pane group, one pane must always be available to fill the area of the pane, so it is not possible for all panes to be minimized simultaneously. One pane will always fill the pane area, even it its minimized state must be ignored to do so. Also, note that a pane can be simultaneously minimized and maximized. The minimzed state will take precedence over the maximized state.
How other panes in a group are resized to accommodate a minimized pane varies depending on whether the group is split horizontally or vertically. A horizontally split group will reduce the minimized pane to a title bar above or below the other panes. If the group is vertically split, the title bars of the pane will appear to the left or right of the other panes. Note that the caption of the pane will be rotated when it is minimized in a vertically split group.
Typically, you will not make use of maximizing and minimizing of panes in the same group at the same time. Because of the requirement that one pane must fill the group area at all times, minimization and maximization do not behave exactly as they do for other windows. Therefore, you risk confusing the user of your application by providing both functions simultaneously.
This property always returns the value that is in effect for the control. Set this property to False to prevent the user from resizing a pane by dragging its edges.
This property always returns the value that is in effect for the control. This property is used to restrict the areas that a pane may be docked.
This property always returns the value that is in effect for the control.
This property always returns the value that is in effect for the control.
This property always returns the value that is in effect for the control.
This property always returns the value that is in effect for the control. This property specifies the amount of blank space that will appear beween the contents of the pane and the pane's left edge.
This property always returns the value that is in effect for the control. This property specifies the amount of blank space that will appear beween the contents of the pane and the pane's right edge.
This property always returns the value that is in effect for the control. This property specifies the amount of blank space that will appear beween the contents of the pane and the pane's top edge.
This property always returns the value that is in effect for the control. This property specifies the amount of blank space that will appear beween the contents of the pane and the pane's bottom edge.
This property always returns the value that is in effect for the control.
By default when double clicking on the caption, tab or sliding group element of a pane, its state is toggled. If the pane was docked, the pane and any descendants are returned to their previous floating positions. If the pane was floating, the pane and any descendants are returned to their previous docked positions.
By default, the grab handle style is based on the
The UltraDockManager provides Visual Studio .Net style docking functionality, including the
ability to unpin/autohide controls. Unpinned controls appear as tab items in the
The docking functionality is controlled via 3 types of panes -
Default settings that will apply to all panes can be set using the
The
The
The
The information managed by the UltraDockManager can be persisted and restored
using the load and save methods. Separate methods exist for persisting the contents of the control to
either a SOAP format (
DesignTime: The UltraDockManager provides full support for design time functionality.
Panes may be floated, docked and dragged just as they can at run time. Panes may also be unpinned at design time
providing complete WYSIWYG control over the appearance of the product without the need to run the project
to organize the panes. Controls may be docked by selecting undocked controls on the form, pressing right click
and selecting "Dock Controls". A dialog is displayed to control how and where the controls are grouped. All the
selected panes will be group together into a single
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Use this method to determine if an Appearance object has been created and contains data that needs to be serialized.
Use this method to reset the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
The functionality is similar
If any of the controls are managed by an existing
Raising an event invokes the event handler through a delegate.
The OnMouseEnterElement method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnMouseEnterElement in a derived class, be sure to call the base class's OnMouseEnterElement method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnMouseLeaveElement method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnMouseLeaveElement in a derived class, be sure to call the base class's OnMouseLeaveElement method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnAfterDockChange method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnAfterDockChange in a derived class, be sure to call the base class's OnAfterDockChange method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnAfterPaneButtonClick method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnAfterPaneButtonClick in a derived class, be sure to call the base class's OnAfterPaneButtonClick method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnAfterSplitterDrag method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnAfterSplitterDrag in a derived class, be sure to call the base class's OnAfterSplitterDrag method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnAfterToggleDockState method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnAfterToggleDockState in a derived class, be sure to call the base class's OnAfterToggleDockState method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnAfterNavigatorClosed method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnAfterNavigatorClosed in a derived class, be sure to call the base class's OnAfterNavigatorClosed method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnBeforeDockChangeStart method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnBeforeDockChangeStart in a derived class, be sure to call the base class's OnBeforeDockChangeStart method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnBeforeDockChange method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnBeforeDockChange in a derived class, be sure to call the base class's OnBeforeDockChange method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnBeforePaneButtonClick method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnBeforePaneButtonClick in a derived class, be sure to call the base class's OnBeforePaneButtonClick method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnBeforeSplitterDrag method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnBeforeSplitterDrag in a derived class, be sure to call the base class's OnBeforeSplitterDrag method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnBeforeToggleDockState method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnBeforeToggleDockState in a derived class, be sure to call the base class's OnBeforeToggleDockState method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnBeforeNavigatorDisplayed method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnBeforeNavigatorDisplayed in a derived class, be sure to call the base class's OnBeforeNavigatorDisplayed method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnDoubleClickSplitterBar method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnDoubleClickSplitterBar in a derived class, be sure to call the base class's OnDoubleClickSplitterBar method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnPaneActivate method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnPaneActivate in a derived class, be sure to call the base class's OnPaneActivate method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnPaneDeactivate method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnPaneDeactivate in a derived class, be sure to call the base class's OnPaneDeactivate method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnInitializePane method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnInitializePane in a derived class, be sure to call the base class's OnInitializePane method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnBeforeShowFlyout method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnBeforeShowFlyout in a derived class, be sure to call the base class's OnBeforeShowFlyout method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnAfterHideFlyout method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnAfterHideFlyout in a derived class, be sure to call the base class's OnAfterHideFlyout method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnInitializeNavigatorItem method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnInitializeNavigatorItem in a derived class, be sure to call the base class's OnInitializeNavigatorItem method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnInitializeNavigatorItemDescription method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnInitializeNavigatorItemDescription in a derived class, be sure to call the base class's OnInitializeNavigatorItemDescription method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnPaneDisplayed method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnPaneDisplayed in a derived class, be sure to call the base class's OnPaneDisplayed method so that registered delegates receive the event.
Raising an event invokes the event handler through a delegate.
The OnPaneHidden method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnPaneHidden in a derived class, be sure to call the base class's OnPaneHidden method so that registered delegates receive the event.
Note: The location where the settings are stored varies depending on the configuration of the system running the application. Information about where these locations are is currently unavailable in Microsoft's MSDN Library.
Note: The location where the settings are stored varies depending on the configuration of the system running the application. Information about where these locations are is currently unavailable in Microsoft's MSDN Library.
Note: The location where the settings are stored varies depending on the configuration of the system running the application. Information about where these locations are is currently unavailable in Microsoft's MSDN Library.
Returns a Boolean value that determines whether the
Returns True if the
Invoke the
Invoke this method to reset the
Once this method is invoked, the
Splitter bars are displayed along the edges of docked
The default borderstyle for the splitter bars is none. However, when the property is left set to Default at design time, the borders will be displayed using the Dotted style so that the splitter bars may be seen.
When using app styling, it is possible to override the borders for the autohide control (i.e. the flyout pane) splitter, the dockarea splitter and the splitter displayed within a horizontal/vertical group separately in which case this property may not return the value for all of the splitter bar types.
Use this property to determine if an
Use this property to determine if an
When a pane caption button such as the Maximize button is visible (see
When set to a color other than Color.Transparent (the default), all occurrences of the color in the image will be made transparent.
If an image is supplied by setting an Appearance.Image property to an Imagelist index, the ImageLists TransparentColor property is looked at first. If that property is set to Color.TransparentColor, then the component's ImageTransparentColor is used. If it is set to Color.TransparentColor, then no color masking is done.
If an image is supplied by setting the Appearance.Image property to an image, the component's ImageTransparentColor is used. If it is set to Color.TransparentColor, then no color masking is done.
By default, drag drop operations are enabled. If the mouse is moved over a sliding group or tab item during a drag drop operation, the associated pane is selected. If the mouse is moved over the tab item for an unpinned control pane during a drag drop operation, the control will flyout.
By default, hovering the mouse over an unpinned tab will cause it to flyout.
When set to Standard, which is the default value, the docked
When set to FillContainer, the innermost DockAreaPane, the
last visible DockAreaPane in the
Note: When using FillContainer, if any control has their fill property set to false, there will
be no fill pane. Also, since the dock areas implement the
This will only be used if the
A control pane is considered to be taken out of view when one of the following conditions are met:
Note: These events are not tied to the actual visibility of the
dockable windows but instead are based on what should be in view assuming the
A control pane is considered to be taken out of view when any of the following conditions are met:
Note: The location where the settings are stored varies depending on the configuration of the system running the application. Information about where these locations are is currently unavailable in Microsoft's MSDN Library.
Note: The location where the settings are stored varies depending on the configuration of the system running the application. Information about where these locations are is currently unavailable in Microsoft's MSDN Library.
Refer to the documentation of the