Rectangle.Contains Method

Definition

Namespace:

System.Drawing

Assembly:

System.Drawing.Primitives.dll

Determines if the specified point is contained within the rectangular region defined by this Rectangle.

Overloads

Contains(Point)	Determines if the specified point is contained within this Rectangle structure.
Contains(Rectangle)	Determines if the rectangular region represented by rect is entirely contained within this Rectangle structure.
Contains(Int32, Int32)	Determines if the specified point is contained within this Rectangle structure.

Contains(Point)

Source:

Rectangle.cs

Determines if the specified point is contained within this Rectangle structure.

public:
 bool Contains(System::Drawing::Point pt);

public readonly bool Contains (System.Drawing.Point pt);

member this.Contains : System.Drawing.Point -> bool

Public Function Contains (pt As Point) As Boolean

Parameters

pt

Point

The Point to test.

Returns

Boolean

This method returns true if the point represented by pt is contained within this Rectangle structure; otherwise false.

Remarks

The containing rectangle must be normalized for this method to return accurate results.

Contains(Rectangle)

Source:

Rectangle.cs

Determines if the rectangular region represented by rect is entirely contained within this Rectangle structure.

public:
 bool Contains(System::Drawing::Rectangle rect);

public readonly bool Contains (System.Drawing.Rectangle rect);

member this.Contains : System.Drawing.Rectangle -> bool

Public Function Contains (rect As Rectangle) As Boolean

Parameters

rect

Rectangle

The Rectangle to test.

Returns

Boolean

This method returns true if the rectangular region represented by rect is entirely contained within this Rectangle structure; otherwise false.

Examples

The following code example demonstrates the Contains method and the SystemPens class. This example is designed for use with a Windows Form. Paste this code into a form that contains a button named Button1, call DrawFirstRectangle from the form's constructor or Load method, and associate the Button1_Click method with the button's Click event.

private:
   [UIPermission(SecurityAction::Demand, Window=UIPermissionWindow::AllWindows)]
   void DrawFirstRectangle()
   {
      Rectangle rectangle1 = Rectangle(70,70,100,150);
      ControlPaint::DrawReversibleFrame( rectangle1, SystemColors::Highlight, FrameStyle::Thick );
   }

   void Button1_Click( Object^ /*sender*/, EventArgs^ /*e*/ )
   {
      Rectangle rectangle1 = Rectangle(70,70,100,150);

      // Get the bounds of the screen.
      Rectangle screenRectangle = Screen::PrimaryScreen->Bounds;

      // Check to see if the rectangle is within the bounds of the screen.
      if ( screenRectangle.Contains( rectangle1 ) )
      {
         ControlPaint::DrawReversibleFrame( rectangle1, SystemColors::Highlight, FrameStyle::Thick );

         // Call the Offset method to move the rectangle.
         rectangle1.Offset( 20, 20 );

         // Draw the new, offset rectangle.
         ControlPaint::DrawReversibleFrame( rectangle1, SystemColors::Highlight, FrameStyle::Thick );
      }
   }

Rectangle rectangle1 = new Rectangle(70, 70, 100, 150);

private void DrawFirstRectangle()
{
    ControlPaint.DrawReversibleFrame(rectangle1, 
        SystemColors.Highlight, FrameStyle.Thick);
}

private void Button1_Click(object sender, EventArgs e)
{

    // Get the bounds of the screen.
    Rectangle screenRectangle = Screen.PrimaryScreen.Bounds;

    // Check to see if the rectangle is within the bounds of the screen.
    if (screenRectangle.Contains(rectangle1))

        // If so, erase the previous rectangle.
    {
        ControlPaint.DrawReversibleFrame(rectangle1, 
            SystemColors.Highlight, FrameStyle.Thick);

        // Call the Offset method to move the rectangle.
        rectangle1.Offset(20, 20);

        // Draw the new, offset rectangle.
        ControlPaint.DrawReversibleFrame(rectangle1, 
            SystemColors.Highlight, FrameStyle.Thick);
    }
}

Dim rectangle1 As New Rectangle(70, 70, 100, 150)

Private Sub DrawFirstRectangle()
    ControlPaint.DrawReversibleFrame(rectangle1, _
        SystemColors.Highlight, FrameStyle.Thick)
End Sub

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

    ' Get the bounds of the screen.
    Dim screenRectangle As Rectangle = Screen.PrimaryScreen.Bounds

    ' Check to see if the rectangle is within the bounds of the screen.
    If (screenRectangle.Contains(rectangle1)) Then

        ' If so, erase the previous rectangle.
        ControlPaint.DrawReversibleFrame(rectangle1, _
            SystemColors.Highlight, FrameStyle.Thick)

        ' Call the Offset method to move the rectangle.
        rectangle1.Offset(20, 20)

        ' Draw the new, offset rectangle.
        ControlPaint.DrawReversibleFrame(rectangle1, _
            SystemColors.Highlight, FrameStyle.Thick)
    End If
End Sub

Remarks

The containing rectangle must be normalized for this method to return accurate results.

Contains(Int32, Int32)

Source:

Rectangle.cs

Determines if the specified point is contained within this Rectangle structure.

public:
 bool Contains(int x, int y);

public readonly bool Contains (int x, int y);

member this.Contains : int * int -> bool

Public Function Contains (x As Integer, y As Integer) As Boolean

Parameters

x

Int32

The x-coordinate of the point to test.

y

Int32

The y-coordinate of the point to test.

Returns

Boolean

This method returns true if the point defined by x and y is contained within this Rectangle structure; otherwise false.

Remarks

The containing rectangle must be normalized for this method to return accurate results.