Skip to main content

Box Class

Box is a public class representing a rectangle, employed for highlighting and positional referencing.

Definition​

  • Namespace: UiPath.DocumentProcessing.Contracts
  • Assembly: UiPath.DocumentProcessing.Contracts

Description​

Box is a public class that represents a rectangle, used for evidencing and positional referencing, throughout the entire assembly. When serialized, a Box is stored as an array of four double values, representing the [Top, Left, Width and Height] of the respective Box object.

Members​

Methods​

  • CreateChecked(double Top, double left, double Width,double Height) - A static method that returns an instance of the Box class with the properties provided as arguments. This method checks that all provided values are greater than 0, to ensure valid objects are created.
  • CreateSize(double Width, double Height) - A static method that creates an instance of the Box class with a (0,0) position and the width and height that are provided as arguments.
  • CreateUnchecked(double Top, double left, double Width, double Height) - A static method that returns an instance of the Box class with the properties provided as arguments. This method does not perform any sanity checks on the arguments.
  • CreateUncheckedWithNoRounding(double Top, double Left,double Width, double Height) - A static method that returns an instance of the Box class with the properties provided as arguments. This method does not perform any sanity checks or rounding on the arguments.
  • Equals(object Box) - Checks if the argument is a box and if its properties are equal. Returns a boolean value.
  • Equals(Box Box)
    • Checks if the object is equal to the argument, property-wise.
  • GetHashCode() - Returns the hash code for the instance.
  • operator !=(Box Box) - A static method that returns True if the two boxes have different property values.
  • operator == (Box Box) - A static method that returns True if the two boxes have equal property values.

Properties​

  • Area double - The area of the box.
  • Bottom double -The bottom position of the box.
  • Height double - The height of the box.
  • HorizontalCenter double - The horizontal center of the box, as Left + Width / 2.
  • IsEmpty double - Specifies whether the Box equals Box.None, property-wise.
  • Left double - The left margin of the box.
  • Right double - The right margin position of the box.
  • Top double - The top position of the box.
  • VerticalCenter double - The vertical center of the box, as Top + Height / 2.
  • Width double - The width of the box.
  • None - A static read-only that returns a new Box instance with top, left, width and height equal to 0.