 | PdfRectangle Class |
Class represents a rectangular region in PDF world coordinates.
The rectangle is kept normalized.
Inheritance HierarchyNamespace: Opait.Pdf.Api
Assembly: Opait.Pdf.Api (in Opait.Pdf.Api.dll) Version: 1.3.3.0
SyntaxC#
public class PdfRectangle : IEquatable<PdfRectangle>
The PdfRectangle type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PdfRectangle |
Initializes a new instance of the PdfRectangle class.
|
| PdfRectangle(IReadOnlyListPdfRectangle) |
Initializes a new instance of the PdfRectangle as the union
of the specified list of rectangles.
|
| PdfRectangle(PdfRectangle) |
Initializes a new instance as a copy of the specified PdfRectangle.
|
| PdfRectangle(XElement, Int32) |
Initializes a new instance of the PdfRectangle class from a serialized XML element.
|
| PdfRectangle(Double, Double, Double, Double) |
Initializes a new instance of the PdfRectangle class with specified coordinates.
|
Properties| Name | Description | |
|---|---|---|
 | Angle |
Gets or sets the rotation angle, counterclockwise, in degrees.
Supported values are 0, 90 and 270. Used in text processing.
|
| BottomLeft |
Gets the bottom-left point of the rectangle.
|
| BottomRight |
Gets the bottom-right point of the rectangle.
|
| Center |
Gets the center point of the rectangle.
|
| Height |
Gets the height of the rectangle.
|
| IsEmpty |
Gets a flag to indicate an empty rectangle within a tolerance.
|
| IsNormalized |
Gets a flag to indicate whether the rectangle is normalized.
|
| IsVertical |
Gets a flag to indicate whether the character is vertically rotated.
|
| TopLeft |
Gets the top-left point of the rectangle.
|
| TopRight |
Gets the top-right point of the rectangle.
|
| Width |
Gets the width of the rectangle.
|
| X |
The X coordinate or the rectangle (bottom-left corner).
|
| Y |
The Y coordinate or the rectangle (bottom-left corner).
|
Methods| Name | Description | |
|---|---|---|
 | CenterComparer |
Compares centers of rectangles for top-down, left-right sorting.
|
| Contains(PdfPoint) |
Determines if the rectangle contains the specified point.
|
| Contains(PdfRectangle) |
Determines if the current rectangle contains the specified rectangle.
|
| ContainsOrIntersects |
Determines if the current rectangle contains or intersects the specified rectangle.
|
| CopyFrom |
Copy coordinates, BUT NOT THE ANGLE, from another instance of PdfRectangle.
|
| Deflate |
Deflates the rectangle by specified size in each direction.
|
| Equals(Object) |
Compares this instance to the specified object.
(Overrides ObjectEquals(Object).) |
| Equals(PdfRectangle) |
Compares this instance to the specified instance.
|
| Equals(PdfRectangle, Double) |
Compares this instance to the specified other instance
for approximate equality within the given tolerance.
|
| FromXml |
Initializes a new instance from a serialized XML element.
|
| GetHashCode |
Gets a custom hash code for this instance.
(Overrides ObjectGetHashCode.) |
| HorizontalOverlap |
Computes relative horizontal overlap with another rectangle.
|
| HorizontalOverlaps |
Checks whether this rectangle has a horizontal overlap with another rectangle.
|
| Inflate |
Inflates the rectangle by specified size in each direction.
|
| Intersect |
Make this object the intersection of itself with a specified rectangle.
|
| Intersects |
Checks whether this rectangle intersects with the specified rectangle.
|
| Normalize |
Normalizes the rectangle so that Right >= Left and Top >= Bottom.
|
| Rotate |
Rotate rectangle counterclockwise about the origin of
the page where it is defined in 90 degree intervals.
|
| SetEmpty |
Set this object to an empty rectangle with zero sides.
|
| ToArray |
Converts coordinates to an array of double precision numbers.
|
| ToString |
Converts this object to a human-readable string.
(Overrides ObjectToString.) |
| ToXml |
Serializes the current instance as an XML element.
|
| Union |
Merges the specified rectangle into the current one.
|
| VerticalOverlap |
Computes relative vertical overlap with another rectangle.
|
| VerticalOverlaps |
Checks whether this rectangle has a vertical overlap with another rectangle.
|
Fields| Name | Description | |
|---|---|---|
 | Bottom |
The bottom coordinate of the rectangle.
|
| Empty |
Represents a PdfRect that has coordinates set to zero.
|
| Left |
The left coordinate of the rectangle.
|
| Right |
The right coordinate of the rectangle.
|
| Top |
The top coordinate of the rectangle.
|
See Also