1 out of 1 rated this helpful Rate this topic

Rectangle Structure

.NET Framework 4

Other Versions

Stores a set of four integers that represent the location and size of a rectangle

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

Syntax

C++

Copy

[SerializableAttribute]
[TypeConverterAttribute(typeof(RectangleConverter))]
[ComVisibleAttribute(true)]
public struct Rectangle

The Rectangle type exposes the following members.

Constructors

	Name	Description
	Rectangle(Point, Size)	Initializes a new instance of the Rectangle class with the specified location and size.
	Rectangle(Int32, Int32, Int32, Int32)	Initializes a new instance of the Rectangle class with the specified location and size.

Top

Properties

	Name	Description
	Bottom	Gets the y-coordinate that is the sum of the Y and Height property values of this Rectangle structure.
	Height	Gets or sets the height of this Rectangle structure.
	IsEmpty	Tests whether all numeric properties of this Rectangle have values of zero.
	Left	Gets the x-coordinate of the left edge of this Rectangle structure.
	Location	Gets or sets the coordinates of the upper-left corner of this Rectangle structure.
	Right	Gets the x-coordinate that is the sum of X and Width property values of this Rectangle structure.
	Size	Gets or sets the size of this Rectangle.
	Top	Gets the y-coordinate of the top edge of this Rectangle structure.
	Width	Gets or sets the width of this Rectangle structure.
	X	Gets or sets the x-coordinate of the upper-left corner of this Rectangle structure.
	Y	Gets or sets the y-coordinate of the upper-left corner of this Rectangle structure.

Top

Methods

	Name	Description
	Ceiling	Converts the specified RectangleF structure to a Rectangle structure by rounding the RectangleF values to the next higher integer values.
	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.
	Equals	Tests whether obj is a Rectangle structure with the same location and size of this Rectangle structure. (Overrides ValueType.Equals(Object).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FromLTRB	Creates a Rectangle structure with the specified edge locations.
	GetHashCode	Returns the hash code for this Rectangle structure. For information about the use of hash codes, see GetHashCode . (Overrides ValueType.GetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Inflate(Size)	Enlarges this Rectangle by the specified amount.
	Inflate(Int32, Int32)	Enlarges this Rectangle by the specified amount.
	Inflate(Rectangle, Int32, Int32)	Creates and returns an enlarged copy of the specified Rectangle structure. The copy is enlarged by the specified amount. The original Rectangle structure remains unmodified.
	Intersect(Rectangle)	Replaces this Rectangle with the intersection of itself and the specified Rectangle.
	Intersect(Rectangle, Rectangle)	Returns a third Rectangle structure that represents the intersection of two other Rectangle structures. If there is no intersection, an empty Rectangle is returned.
	IntersectsWith	Determines if this rectangle intersects with rect.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Offset(Point)	Adjusts the location of this rectangle by the specified amount.
	Offset(Int32, Int32)	Adjusts the location of this rectangle by the specified amount.
	Round	Converts the specified RectangleF to a Rectangle by rounding the RectangleF values to the nearest integer values.
	ToString	Converts the attributes of this Rectangle to a human-readable string. (Overrides ValueType.ToString.) In XNA Framework 3.0, this member is inherited from Object.ToString.
	Truncate	Converts the specified RectangleF to a Rectangle by truncating the RectangleF values.
	Union	Gets a Rectangle structure that contains the union of two Rectangle structures.

Top

Operators

	Name	Description
	Equality	Tests whether two Rectangle structures have equal location and size.
	Inequality	Tests whether two Rectangle structures differ in location or size.

Top

Fields

	Name	Description
	Empty	Represents a Rectangle structure with its properties left uninitialized.

Top

Remarks

A rectangle is defined by its Width, Height, and upper-left corner represented by the Location property.

To draw rectangles, you need a Graphics object and a Pen object. The Graphics object provides the DrawRectangle method, and the Pen object stores features of the line, such as color and width. The units the rectangle is drawn in is determined by the PageUnit and PageScale properties of the graphics object used for drawing. The default unit is pixels.

To draw a Rectangle filled with color, you need a Graphics object and an object derived from Brush such as SolidBrush or LinearGradientBrush. The Graphics object provides the FillRectangle method and the Brush object provides the color and fill information.

For more advanced shapes, use a Region object.

Examples

The following example draws a rectangle with its upper-left corner at (10, 10). The rectangle has a width of 100 and a height of 50. The second argument passed to the Pen constructor indicates that the pen width is 5 pixels.

When the rectangle is drawn, the pen is centered on the rectangle's boundary. Because the pen width is 5, the sides of the rectangle are drawn 5 pixels wide, such that 1 pixel is drawn on the boundary itself, 2 pixels are drawn on the inside, and 2 pixels are drawn on the outside. For more details on pen alignment, see How to: Set Pen Width and Alignment.

The following illustration shows the resulting rectangle. The dotted lines show where the rectangle would have been drawn if the pen width had been one pixel. The enlarged view of the upper-left corner of the rectangle shows that the thick black lines are centered on those dotted lines.

This example is designed for use with Windows Forms, and it requires PaintEventArgs e, which is a parameter of the Paint event handler.

Copy


Pen blackPen = new Pen(Color.FromArgb(255, 0, 0, 0), 5);
e.Graphics.DrawRectangle(blackPen, 10, 10, 100, 50);

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

System.Drawing Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(2000 characters remaining)

Community Content Add

FAQ