Control.GetPreferredSize(Size) Method

Definition

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

public:
 virtual System::Drawing::Size GetPreferredSize(System::Drawing::Size proposedSize);
public virtual System.Drawing.Size GetPreferredSize (System.Drawing.Size proposedSize);
abstract member GetPreferredSize : System.Drawing.Size -> System.Drawing.Size
override this.GetPreferredSize : System.Drawing.Size -> System.Drawing.Size
Public Overridable Function GetPreferredSize (proposedSize As Size) As Size

Parameters

proposedSize
Size

The custom-sized area for a control.

Returns

An ordered pair of type Size representing the width and height of a rectangle.

Implements

System.Windows.Forms.Layout.IArrangedElement.GetPreferredSize(System.Drawing.Size)

Remarks

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.

Applies to