Control.ClientRectangle Property (System.Windows.Forms)

ClientRectangle Property

.NET Framework Class Library

Control..::.ClientRectangle Property

Gets the rectangle that represents the client area of the control.

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

Syntax

Visual Basic (Declaration)

<BrowsableAttribute(False)> _
Public ReadOnly Property ClientRectangle As Rectangle

Visual Basic (Usage)

Dim instance As Control
Dim value As Rectangle

value = instance.ClientRectangle

[BrowsableAttribute(false)]
public Rectangle ClientRectangle { get; }

Visual C++

[BrowsableAttribute(false)]
public:
property Rectangle ClientRectangle {
    Rectangle get ();
}

JScript

public function get ClientRectangle () : Rectangle

Property Value

Type: System.Drawing..::.Rectangle
A Rectangle that represents the client area of the control.

Remarks

The client area of a control is the bounds of the control, minus the nonclient elements such as scroll bars, borders, title bars, and menus.

Because client coordinates are relative to the upper-left corner of the client area of the control, the coordinates of the upper-left corner of the rectangle returned by this property are (0,0). You can use this property to obtain the size and coordinates of the client area of the control for tasks such as drawing on the surface of the control.

For more information about drawing on controls, see Rendering a Windows Forms Control.

Examples

The following code example enables auto-scrolling for a form, resizes the form, and ensures that a button remains visible after the form is resized. This example requires that you have a Form with a Button named button2 on it.

Visual Basic

Private Sub ResizeForm()
   ' Enable auto-scrolling for the form.
   Me.AutoScroll = True

   ' Resize the form.
   Dim r As Rectangle = Me.ClientRectangle
   ' Subtract 100 pixels from each side of the Rectangle.
   r.Inflate(- 100, - 100)
   Me.Bounds = Me.RectangleToScreen(r)

   ' Make sure button2 is visible.
   Me.ScrollControlIntoView(button2)
End Sub

private void ResizeForm()
{
   // Enable auto-scrolling for the form.
   this.AutoScroll = true;

   // Resize the form.
   Rectangle r = this.ClientRectangle;
   // Subtract 100 pixels from each side of the Rectangle.
   r.Inflate(-100, -100);
   this.Bounds = this.RectangleToScreen(r);

   // Make sure button2 is visible.
   this.ScrollControlIntoView(button2);
}

Visual C++

private:
   void ResizeForm()
   {

      // Enable auto-scrolling for the form.
      this->AutoScroll = true;

      // Resize the form.
      Rectangle r = this->ClientRectangle;

      // Subtract 100 pixels from each side of the Rectangle.
      r.Inflate(  -100, -100 );
      this->Bounds = this->RectangleToScreen( r );

      // Make sure button2 is visible.
      this->ScrollControlIntoView( button2 );
   }

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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

Reference

Control Class

Control Members

System.Windows.Forms Namespace

ClientSize

DrawMode