Rectangle.Contains Method (Rectangle)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

Namespace:   System.Drawing
Assembly:  System.Drawing (in System.Drawing.dll)

public bool Contains(
	Rectangle rect
)

Parameters

rect
Type: System.Drawing.Rectangle

The Rectangle to test.

Return Value

Type: System.Boolean

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

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

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.

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);
    }
}

.NET Framework
Available since 1.1
Return to top
Show: