GetPreferredSize Method (EditBase)

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

Syntax

Visual Basic
C#

'Declaration
 
Public Overrides Function GetPreferredSize( _
   ByVal proposedSize As Size _
) As Size

'Usage
 
Dim instance As EditBase
Dim proposedSize As Size
Dim value As Size
 
value = instance.GetPreferredSize(proposedSize)

public override Size GetPreferredSize( 
   Size proposedSize
)

Parameters

proposedSize: The custom-sized area for a control.

Return Value

An ordered pair of type System.Drawing.Size objects that represent 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 is defined as unconstrained.

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

Reference

EditBase Class
EditBase Members