Control.GetPreferredSize Method (System.Windows.Forms)

.NET Framework Class Library

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)

Public Overridable Function GetPreferredSize ( _
	proposedSize As Size _
) As Size

public virtual Size GetPreferredSize(
	Size proposedSize
)

public:
virtual Size GetPreferredSize(
	Size proposedSize
)

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.

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.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

Control Class

System.Windows.Forms Namespace

Advertise Here