Struct Rect

Describes the width, height, and point origin of a rectangle.

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: System.Windows

Assembly: OpenSilver.dll

Syntax

public struct Rect

Constructors

| Improve this Doc View Source

Rect(Double, Double, Double, Double)

Initializes a Rect structure that has the specified x-coordinate, y-coordinate, width, and height.

Declaration

public Rect(double x, double y, double width, double height)

Parameters

Type	Name	Description
System.Double	x	The x-coordinate of the top-left corner of the rectangle.
System.Double	y	The y-coordinate of the top-left corner of the rectangle.
System.Double	width	The width of the rectangle.
System.Double	height	The height of the rectangle.

Exceptions

Type	Condition
System.ArgumentException	width or height are less than 0.

| Improve this Doc View Source

Rect(Point, Point)

Initializes a Rect structure that is exactly large enough to contain the two specified points.

Declaration

public Rect(Point point1, Point point2)

Parameters

Type	Name	Description
Point	point1	The first point that the new rectangle must contain.
Point	point2	The second point that the new rectangle must contain.

| Improve this Doc View Source

Rect(Point, Size)

Initializes a Rect structure based on an origin and size.

Declaration

public Rect(Point location, Size size)

Parameters

Type	Name	Description
Point	location	The origin of the new Rect.
Size	size	The size of the new Rect.

| Improve this Doc View Source

Rect(Size)

Initializes a new instance of the Rect structure that is of the specified size and is located at (0,0).

Declaration

public Rect(Size size)

Parameters

Type	Name	Description
Size	size	The size of the new Rect.

Properties

| Improve this Doc View Source

Bottom

Gets the y-axis value of the bottom of the rectangle.

Declaration

public readonly double Bottom { get; }

Property Value

Type	Description
System.Double

| Improve this Doc View Source

BottomLeft

Gets the position of the bottom-left corner of the rectangle

Declaration

public readonly Point BottomLeft { get; }

Property Value

Type	Description
Point

| Improve this Doc View Source

BottomRight

Gets the position of the bottom-right corner of the rectangle.

Declaration

public readonly Point BottomRight { get; }

Property Value

Type	Description
Point

| Improve this Doc View Source

Empty

Gets a special value that represents a rectangle with no position or area.

Declaration

public static readonly Rect Empty { get; }

Property Value

Type	Description
Rect

| Improve this Doc View Source

Height

Gets or sets the height of the rectangle.

Declaration

public double Height { get; set; }

Property Value

Type	Description
System.Double

| Improve this Doc View Source

IsEmpty

Gets a value that indicates whether the rectangle is the Windows.Foundation.Rect.Empty rectangle.

Declaration

public readonly bool IsEmpty { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Left

Gets the x-axis value of the left side of the rectangle.

Declaration

public readonly double Left { get; }

Property Value

Type	Description
System.Double

| Improve this Doc View Source

Location

Gets or sets the position of the top-left corner of the rectangle.

Declaration

public Point Location { get; set; }

Property Value

Type	Description
Point

| Improve this Doc View Source

Right

Gets the x-axis value of the right side of the rectangle.

Declaration

public readonly double Right { get; }

Property Value

Type	Description
System.Double

| Improve this Doc View Source

Size

Gets or sets the width and height of the rectangle.

Declaration

public Size Size { get; set; }

Property Value

Type	Description
Size

| Improve this Doc View Source

Top

Gets the y-axis position of the top of the rectangle.

Declaration

public readonly double Top { get; }

Property Value

Type	Description
System.Double

| Improve this Doc View Source

TopLeft

Gets the position of the top-left corner of the rectangle

Declaration

public readonly Point TopLeft { get; }

Property Value

Type	Description
Point

| Improve this Doc View Source

TopRight

Gets the position of the top-right corner of the rectangle.

Declaration

public readonly Point TopRight { get; }

Property Value

Type	Description
Point

| Improve this Doc View Source

Width

Gets or sets the width of the rectangle.

Declaration

public double Width { get; set; }

Property Value

Type	Description
System.Double

| Improve this Doc View Source

X

Gets or sets the x-axis value of the left side of the rectangle.

Declaration

public double X { get; set; }

Property Value

Type	Description
System.Double

| Improve this Doc View Source

Y

Gets or sets the y-axis value of the top side of the rectangle.

Declaration

public double Y { get; set; }

Property Value

Type	Description
System.Double

Methods

| Improve this Doc View Source

Contains(Point)

Indicates whether the rectangle described by the Windows.Foundation.Rect contains the specified point.

Declaration

public bool Contains(Point point)

Parameters

Type	Name	Description
Point	point	The point to check.

Returns

Type	Description
System.Boolean	true if the rectangle described by the Windows.Foundation.Rect contains the specified point; otherwise, false.

| Improve this Doc View Source

Equals(Object)

Indicates whether the specified object is equal to the current Windows.Foundation.Rect.

Declaration

public override bool Equals(object o)

Parameters

Type	Name	Description
System.Object	o	The object to compare to the current rectangle.

Returns

Type	Description
System.Boolean	true if o is a Windows.Foundation.Rect and has the same x,y,width,height values as the current Windows.Foundation.Rect; otherwise, false.

Overrides

System.ValueType.Equals(System.Object)

| Improve this Doc View Source

Equals(Rect)

Indicates whether the specified Windows.Foundation.Rect is equal to the current Windows.Foundation.Rect.

Declaration

public bool Equals(Rect value)

Parameters

Type	Name	Description
Rect	value	The rectangle to compare to the current rectangle.

Returns

Type	Description
System.Boolean	true if the specified Windows.Foundation.Rect has the same x,y,width,height property values as the current Windows.Foundation.Rect; otherwise, false.

| Improve this Doc View Source

GetHashCode()

Creates a hash code for the Windows.Foundation.Rect.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A hash code for the current Windows.Foundation.Rect structure.

Overrides

System.ValueType.GetHashCode()

| Improve this Doc View Source

Intersect(Rect)

Finds the intersection of the rectangle represented by the current Rect and the rectangle represented by the specified Rect, and stores the result as the current Rect.

Declaration

public void Intersect(Rect rect)

Parameters

Type	Name	Description
Rect	rect	The rectangle to intersect with the current rectangle.

| Improve this Doc View Source

Parse(String)

Declaration

public static Rect Parse(string source)

Parameters

Type	Name	Description
System.String	source

Returns

Type	Description
Rect

| Improve this Doc View Source

ToString()

Returns a string representation of the Rect structure. structure.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string representation of the current Rect structure. The string has the following form: "X,Y,Width,Height".

Overrides

System.ValueType.ToString()

| Improve this Doc View Source

ToString(IFormatProvider)

Returns a string representation of the rectangle by using the specified format provider.

Declaration

public string ToString(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider	Culture-specific formatting information.

Returns

Type	Description
System.String	A string representation of the current rectangle that is determined by the specified format provider.

| Improve this Doc View Source

Union(Point)

Expands the rectangle represented by the current Windows.Foundation.Rect exactly enough to contain the specified point.

Declaration

public void Union(Point point)

Parameters

Type	Name	Description
Point	point	The point to include.

| Improve this Doc View Source

Union(Rect)

Expands the rectangle represented by the current Windows.Foundation.Rect exactly enough to contain the specified rectangle.

Declaration

public void Union(Rect rect)

Parameters

Type	Name	Description
Rect	rect	The rectangle to include.

Operators

| Improve this Doc View Source

Equality(Rect, Rect)

Compares two Windows.Foundation.Rect structures for equality.

Declaration

public static bool operator ==(Rect rect1, Rect rect2)

Parameters

Type	Name	Description
Rect	rect1	The first rectangle to compare.
Rect	rect2	The second rectangle to compare.

Returns

Type	Description
System.Boolean	true if the Windows.Foundation.Rect structures have the same x,y,width,height property values; otherwise, false.

| Improve this Doc View Source

Inequality(Rect, Rect)

Compares two Windows.Foundation.Rect structures for inequality.

Declaration

public static bool operator !=(Rect rect1, Rect rect2)

Parameters

Type	Name	Description
Rect	rect1	The first rectangle to compare.
Rect	rect2	The second rectangle to compare.

Returns

Type	Description
System.Boolean	true if the Windows.Foundation.Rect structures do not have the same x,y,width,height property values; otherwise, false.

Extension Methods

ToJavaScriptObjectExtender.ToJavaScriptObject(Object)