RelativeRectangle Struct

Namespace:
GemBox.Document
Assembly:
GemBox.Document.dll

Specifies the relative rectangle.

public struct RelativeRectangle : IEquatable<RelativeRectangle>
Public Structure RelativeRectangle
    Implements IEquatable(Of RelativeRectangle)
Implements
System.IEquatable<RelativeRectangle>

Constructors

RelativeRectangle(Double, Double, Double, Double)

Initializes a new instance of the RelativeRectangle struct.

public RelativeRectangle(double left, double top, double right, double bottom)
Public Sub New(left As Double, top As Double, right As Double, bottom As Double)
Parameters
left
System.Double

The left.

top
System.Double

The top.

right
System.Double

The right.

bottom
System.Double

The bottom.

Properties

Bottom

Gets or sets the bottom edge of the rectangle.

public double Bottom { readonly get; set; }
Public Property Bottom As Double
Property Value
System.Double

The bottom edge of the rectangle.

Remarks

Value 0 represents 0% while value 1 represents 100%.

Left

Gets or sets the left edge of the rectangle.

public double Left { readonly get; set; }
Public Property Left As Double
Property Value
System.Double

The left edge of the rectangle.

Remarks

Value 0 represents 0% while value 1 represents 100%.

Right

Gets or sets the right edge of the rectangle.

public double Right { readonly get; set; }
Public Property Right As Double
Property Value
System.Double

The right edge of the rectangle.

Remarks

Value 0 represents 0% while value 1 represents 100%.

Top

Gets or sets the top edge of the rectangle.

public double Top { readonly get; set; }
Public Property Top As Double
Property Value
System.Double

The top edge of the rectangle.

Remarks

Value 0 represents 0% while value 1 represents 100%.

Methods

Equals(RelativeRectangle)

Determines whether the other RelativeRectangle is equal to this RelativeRectangle instance.

public bool Equals(RelativeRectangle other)
Public Function Equals(other As RelativeRectangle) As Boolean
Parameters
other
RelativeRectangle

The other relative rectangle to compare with this relative rectangle instance.

Returns
System.Boolean

true if the other RelativeRectangle is equal to this RelativeRectangle instance; otherwise, false.

Equals(Object)

Determines whether the specified System.Object is equal to this RelativeRectangle instance.

public override bool Equals(object obj)
Public Overrides Function Equals(obj As Object) As Boolean
Parameters
obj
System.Object

The System.Object to compare with this relative rectangle instance.

Returns
System.Boolean

true if the specified System.Object is a RelativeRectangle and is equal to this RelativeRectangle instance; otherwise, false.

Overrides
System.ValueType.Equals(System.Object)

GetHashCode()

Returns a hash code for this RelativeRectangle instance.

public override int GetHashCode()
Public Overrides Function GetHashCode As Integer
Returns
System.Int32

An integer value that specifies a hash value for this RelativeRectangle instance.

Overrides
System.ValueType.GetHashCode()

SetBottom(Double)

Sets the bottom edge of the rectangle.

public RelativeRectangle SetBottom(double value)
Public Function SetBottom(value As Double) As RelativeRectangle
Parameters
value
System.Double

The bottom edge of the rectangle.

Returns
RelativeRectangle

A new instance of the RelativeRectangle struct with the bottom edge set to the value.

SetLeft(Double)

Sets the left edge of the rectangle.

public RelativeRectangle SetLeft(double value)
Public Function SetLeft(value As Double) As RelativeRectangle
Parameters
value
System.Double

The left edge of the rectangle.

Returns
RelativeRectangle

A new instance of the RelativeRectangle struct with the left edge set to the value.

SetRight(Double)

Sets the right edge of the rectangle.

public RelativeRectangle SetRight(double value)
Public Function SetRight(value As Double) As RelativeRectangle
Parameters
value
System.Double

The right edge of the rectangle.

Returns
RelativeRectangle

A new instance of the RelativeRectangle struct with the right edge set to the value.

SetTop(Double)

Sets the top edge of the rectangle.

public RelativeRectangle SetTop(double value)
Public Function SetTop(value As Double) As RelativeRectangle
Parameters
value
System.Double

The top edge of the rectangle.

Returns
RelativeRectangle

A new instance of the RelativeRectangle struct with the top edge set to the value.

ToString()

Returns a System.String that represents this RelativeRectangle instance.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String

A System.String that represents this RelativeRectangle instance.

Overrides
System.ValueType.ToString()
Remarks

This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Operators

Equality(RelativeRectangle, RelativeRectangle)

Determines whether first and second RelativeRectangles are equal.

public static bool operator ==(RelativeRectangle first, RelativeRectangle second)
Public Shared Operator =(first As RelativeRectangle, second As RelativeRectangle) As Boolean
Parameters
first
RelativeRectangle

The first relative rectangle.

second
RelativeRectangle

The second relative rectangle.

Returns
System.Boolean

true if first and second relative rectangles are equal; otherwise, false.

Inequality(RelativeRectangle, RelativeRectangle)

Determines whether first and second RelativeRectangles are not equal.

public static bool operator !=(RelativeRectangle first, RelativeRectangle second)
Public Shared Operator <>(first As RelativeRectangle, second As RelativeRectangle) As Boolean
Parameters
first
RelativeRectangle

The first relative rectangle.

second
RelativeRectangle

The second relative rectangle.

Returns
System.Boolean

true if first and second relative rectangles are not equal; otherwise, false.

Implements

System.IEquatable<T>