Rect.Contains Method

Definition

Namespace:

System.Windows

Assembly:

WindowsBase.dll

Indicates whether the rectangle contains the specified point or rectangle.

Overloads

Contains(Point)	Indicates whether the rectangle contains the specified point.
Contains(Rect)	Indicates whether the rectangle contains the specified rectangle.
Contains(Double, Double)	Indicates whether the rectangle contains the specified x-coordinate and y-coordinate.

Contains(Point)

Indicates whether the rectangle contains the specified point.

public:
 bool Contains(System::Windows::Point point);

public bool Contains (System.Windows.Point point);

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

Public Function Contains (point As Point) As Boolean

Parameters

point

Point

The point to check.

Returns

Boolean

true if the rectangle contains the specified point; otherwise, false.

Examples

The following example shows how to use the Contains(Point) method to determine if the rectangle contains the specified Point.

private bool rectContainsExample1()
{
    // Initialize new rectangle.
    Rect myRectangle = new Rect();

    // The Location property specifies the coordinates of the upper left-hand 
    // corner of the rectangle. 
    myRectangle.Location = new Point(10, 5);

    // Set the Size property of the rectangle with a width of 200
    // and a height of 50.
    myRectangle.Size = new Size(200, 50);

    // Using the Contains method, see if the rectangle contains the specified
    // point. doesContain is true because the point is inside of myRectangle.
    bool doesContain = myRectangle.Contains(new Point(13, 30));

    return doesContain;
}

Contains(Rect)

Indicates whether the rectangle contains the specified rectangle.

public:
 bool Contains(System::Windows::Rect rect);

public bool Contains (System.Windows.Rect rect);

member this.Contains : System.Windows.Rect -> bool

Public Function Contains (rect As Rect) As Boolean

Parameters

rect

Rect

The rectangle to check.

Returns

Boolean

true if rect is entirely contained by the rectangle; otherwise, false.

Examples

The following example shows how to use the Contains(Rect) method to determine if one rectangle is contained by another rectangle.

private bool rectContainsExample2()
{
    // Create a rectangle.
    Rect myRectangle1 = new Rect();

    // The Location property specifies the coordinates of the upper left-hand 
    // corner of the rectangle. 
    myRectangle1.Location = new Point(10, 5);

    // Set the Size property of the rectangle with a width of 200
    // and a height of 50.
    myRectangle1.Size = new Size(200, 50);

    // Create second rectangle.
    Rect myRectangle2 = new Rect();
    myRectangle2.Location = new Point(12, 12);
    myRectangle2.Size = new Size(10, 60);

    // Using the Contains method, see if the second rectangle is 
    // contained within the first rectangle. doesContain is false
    // because only part of myRectangle2 is contained in myRectangle1 
    // (myRectangle2 is too wide).
    bool doesContain = myRectangle1.Contains(myRectangle2);

    return doesContain;
}

Contains(Double, Double)

Indicates whether the rectangle contains the specified x-coordinate and y-coordinate.

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

public bool Contains (double x, double y);

member this.Contains : double * double -> bool

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

Parameters

x

Double

The x-coordinate of the point to check.

y

Double

The y-coordinate of the point to check.

Returns

Boolean

true if (x, y) is contained by the rectangle; otherwise, false.

Examples

The following example shows how to use the Contains(Double, Double) method to determine if the rectangle contains the point specified by the given x-coordinate and y-coordinate.

private bool rectContainsExample3()
{
    // Initialize new rectangle.
    Rect myRectangle = new Rect();

    // The Location property specifies the coordinates of the upper left-hand 
    // corner of the rectangle. 
    myRectangle.Location = new Point(10, 5);

    // Set the Size property of the rectangle with a width of 200
    // and a height of 50.
    myRectangle.Size = new Size(200, 50);

    // Using the Contains method, see if the rectangle contains the specified
    // point specified by the given X and Y coordinates. doesContain is false 
    // because the X and Y coordinates specify a point outside of myRectangle.
    bool doesContain = myRectangle.Contains(4, 13);

    return doesContain;
}