Export (0) Print
Expand All
Expand Minimize

Control.GetPreferredSize Method

Retrieves the size of a rectangular area into which a control can be fitted.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

abstract GetPreferredSize : 
        proposedSize:Size -> Size  
override GetPreferredSize : 
        proposedSize:Size -> Size

Parameters

proposedSize
Type: System.Drawing.Size

The custom-sized area for a control.

Return Value

Type: System.Drawing.Size
An ordered pair of type System.Drawing.Size representing the width and height of a rectangle.

The behavior of GetPreferredSize differs by control. The LayoutEngine might be unable to assign the returned size to the control. You can return a size larger than the constraints indicated in the proposedSize parameter, but proposedSize should decrease as the constraint decreases. For example, GetPreferredSize(new Size(100, 0)) should not be wider than GetPreferredSize(new Size(200, 0)). The exception is a proposedSize of 0 or Size.Empty, which are defined as unconstrained.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft