Control.GetPreferredSize Method (System.Windows.Forms)

GetPreferredSize Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.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)

Syntax

Visual Basic (Declaration)

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

Visual Basic (Usage)

Dim instance As Control
Dim proposedSize As Size
Dim returnValue As Size

returnValue = instance.GetPreferredSize(proposedSize)

public virtual Size GetPreferredSize(
    Size proposedSize
)

Visual C++

public:
virtual Size GetPreferredSize(
    Size proposedSize
)

JScript

public function 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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

Control Class

Control Members

System.Windows.Forms Namespace