Form.SetDesktopBounds Method (System.Windows.Forms)

SetDesktopBounds Method

.NET Framework Class Library

Form..::.SetDesktopBounds Method

Sets the bounds of the form in desktop coordinates.

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

Syntax

Visual Basic (Declaration)

Public Sub SetDesktopBounds ( _
    x As Integer, _
    y As Integer, _
    width As Integer, _
    height As Integer _
)

Visual Basic (Usage)

Dim instance As Form
Dim x As Integer
Dim y As Integer
Dim width As Integer
Dim height As Integer

instance.SetDesktopBounds(x, y, width, _
    height)

public void SetDesktopBounds(
    int x,
    int y,
    int width,
    int height
)

Visual C++

public:
void SetDesktopBounds(
    int x, 
    int y, 
    int width, 
    int height
)

JScript

public function SetDesktopBounds(
    x : int, 
    y : int, 
    width : int, 
    height : int
)

Parameters

x: Type: System..::.Int32
The x-coordinate of the form's location.

y: Type: System..::.Int32
The y-coordinate of the form's location.

width: Type: System..::.Int32
The width of the form.

height: Type: System..::.Int32
The height of the form.

Remarks

Desktop coordinates are based on the working area of the screen, which excludes the taskbar. You can use this method to set the position and size of your form on the desktop. Since desktop coordinates are based on the working area of the form, you can use this method to ensure that your form is completely visible on the desktop.

Examples

The following code example demonstrates using the SetDesktopBounds method. To run this example, paste the following code in a form that contains a button named Button2. Ensure all events are associated with their event handlers.

Visual Basic

Private Sub Button2_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button2.Click
    Dim i As Integer
    For i = 0 To 20
        ' With each loop through the code, the form's desktop location is 
        ' adjusted right and down by 10 pixels and its height and width 
        ' are each decreased by 10 pixels. 
        Me.SetDesktopBounds(Me.Location.X + 10, Me.Location.Y + 10, _
            Me.Width - 10, Me.Height - 10)

        ' Call Sleep to show the form gradually shrinking.
        System.Threading.Thread.Sleep(50)
    Next
End Sub

    private void Button2_Click(System.Object sender, System.EventArgs e)
    {
        
        for(int i = 0; i <= 20; i++)
        {
            // With each loop through the code, the form's 
            // desktop location is adjusted right and down
            //  by 10 pixels and its height and width are each
            // decreased by 10 pixels. 
            this.SetDesktopBounds(this.Location.X+10, 
                this.Location.Y+10, this.Width-10, this.Height-10);

            // Call Sleep to show the form gradually shrinking.
            System.Threading.Thread.Sleep(50);
        }
    }

Visual C++

void Button2_Click( System::Object^ sender, System::EventArgs^ e )
{
   for ( int i = 0; i <= 20; i++ )
   {

      // With each loop through the code, the form's 
      // desktop location is adjusted right and down
      //  by 10 pixels and its height and width are each
      // decreased by 10 pixels. 
      this->SetDesktopBounds( this->Location.X + 10, this->Location.Y + 10, this->Width - 10, this->Height - 10 );

      // Call Sleep to show the form gradually shrinking.
      System::Threading::Thread::Sleep( 50 );

   }
}

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

Reference

Form Class

Form Members

System.Windows.Forms Namespace

SetDesktopLocation