Size Property (DockPaneBase)

Returns/sets the value used to determine the size of the pane in proportion to other panes in the same docking area.

Syntax

Visual Basic
C#

'Declaration
 
Public Property Size As Size

'Usage
 
Dim instance As DockPaneBase
Dim value As Size
 
instance.Size = value
 
value = instance.Size

public Size Size {get; set;}

Remarks

This size value does not necessarily equal the size actually used to display the pane. The DisplaySize property indicates the size at which the pane is currently displayed. The ratio of the Size properties of the child panes is used to determine the actual size of each pane.

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 for determining its size proportional 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.

Requirements

Target Platforms: Windows XP SP3 (32-bit and 64-bit), Windows 7 (32-bit and 64-bit)

Not all Operating Systems are supported on all products. Visit the ArcFM Solution Supported Versions page for full details.

Reference

DockPaneBase Class
DockPaneBase Members