Screen.GetWorkingArea Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Retrieves the working area of a display.

Overloads

GetWorkingArea(Point)	Retrieves the working area closest to the specified point. The working area is the desktop area of the display, excluding taskbars, docked windows, and docked tool bars.
GetWorkingArea(Rectangle)	Retrieves the working area for the display that contains the largest portion of the specified rectangle. The working area is the desktop area of the display, excluding taskbars, docked windows, and docked tool bars.
GetWorkingArea(Control)	Retrieves the working area for the display that contains the largest region of the specified control. The working area is the desktop area of the display, excluding taskbars, docked windows, and docked tool bars.

GetWorkingArea(Point)

Retrieves the working area closest to the specified point. The working area is the desktop area of the display, excluding taskbars, docked windows, and docked tool bars.

public:
 static System::Drawing::Rectangle GetWorkingArea(System::Drawing::Point pt);

public static System.Drawing.Rectangle GetWorkingArea (System.Drawing.Point pt);

static member GetWorkingArea : System.Drawing.Point -> System.Drawing.Rectangle

Public Shared Function GetWorkingArea (pt As Point) As Rectangle

Parameters

pt

Point

A Point that specifies the coordinates for which to retrieve the working area.

Returns

Rectangle

A Rectangle that specifies the working area. In multiple display environments where no display contains the specified point, the display closest to the point is returned.

Examples

The following code example demonstrates the use of PrimaryScreen property and the GetWorkingArea method. This method requires a form containing a button named Button1

   // This method will adjust the size of the form to utilize 
   // the working area of the screen.
private:
   void Button1_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      // Retrieve the working rectangle from the Screen class
      // using the PrimaryScreen and the WorkingArea properties.
      System::Drawing::Rectangle workingRectangle = Screen::PrimaryScreen->WorkingArea;
      
      // Set the size of the form slightly less than size of 
      // working rectangle.
      this->Size = System::Drawing::Size( workingRectangle.Width - 10, workingRectangle.Height - 10 );
      
      // Set the location so the entire form is visible.
      this->Location = System::Drawing::Point( 5, 5 );
   }

// This method will adjust the size of the form to utilize 
// the working area of the screen.
private void Button1_Click(System.Object sender, System.EventArgs e)
{
    // Retrieve the working rectangle from the Screen class
    // using the PrimaryScreen and the WorkingArea properties.
    System.Drawing.Rectangle workingRectangle = 
        Screen.PrimaryScreen.WorkingArea;
    
    // Set the size of the form slightly less than size of 
    // working rectangle.
    this.Size = new System.Drawing.Size(
        workingRectangle.Width-10, workingRectangle.Height-10);

    // Set the location so the entire form is visible.
    this.Location = new System.Drawing.Point(5, 5);
}

' This method will adjust the size of the form to utilize 
' the working area of the screen.

Private Sub Button1_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button1.Click

    ' Retrieve the working rectangle from the Screen class
    ' using the PrimaryScreen and the WorkingArea properties. 
    Dim workingRectangle As System.Drawing.Rectangle = _
        Screen.PrimaryScreen.WorkingArea

    ' Set the size of the form slightly less than size of 
    ' working rectangle.
    Me.Size = New System.Drawing.Size(workingRectangle.Width - 10, _
        workingRectangle.Height - 10)

    ' Set the location so the entire form is visible.
    Me.Location = New System.Drawing.Point(5, 5)

End Sub

GetWorkingArea(Rectangle)

Retrieves the working area for the display that contains the largest portion of the specified rectangle. The working area is the desktop area of the display, excluding taskbars, docked windows, and docked tool bars.

public:
 static System::Drawing::Rectangle GetWorkingArea(System::Drawing::Rectangle rect);

public static System.Drawing.Rectangle GetWorkingArea (System.Drawing.Rectangle rect);

static member GetWorkingArea : System.Drawing.Rectangle -> System.Drawing.Rectangle

Public Shared Function GetWorkingArea (rect As Rectangle) As Rectangle

Parameters

rect

Rectangle

The Rectangle that specifies the area for which to retrieve the working area.

Returns

Rectangle

A Rectangle that specifies the working area. In multiple display environments where no display contains the specified rectangle, the display closest to the rectangle is returned.

GetWorkingArea(Control)

Retrieves the working area for the display that contains the largest region of the specified control. The working area is the desktop area of the display, excluding taskbars, docked windows, and docked tool bars.

public:
 static System::Drawing::Rectangle GetWorkingArea(System::Windows::Forms::Control ^ ctl);

public static System.Drawing.Rectangle GetWorkingArea (System.Windows.Forms.Control ctl);

static member GetWorkingArea : System.Windows.Forms.Control -> System.Drawing.Rectangle

Public Shared Function GetWorkingArea (ctl As Control) As Rectangle

Parameters

ctl

Control

The Control for which to retrieve the working area.

Returns

Rectangle

A Rectangle that specifies the working area. In multiple display environments where no display contains the specified control, the display closest to the control is returned.