PdfRect Object

Overview

PdfRect represents a rectangle defined by the coordinates of its lower-left and upper-right corners. An instance of the PdfRect object is returned by several properties and methods such as PdfPage's MediaBox or PdfFont's GetTextExtent.

Member List

Properties


float Bottom (Read/Write)
Returns or specifies the Y coordinate of the rectangle's lower-left corner.

float Height (Read/Write)
Returns or specifies rectangle's height which is computed as an absolute difference between its Top and Bottom properties. Setting this property has a side effect of modifying the Top property.

PdfParam ImageInfo (Read-only)

Returns an instance of the PdfParam object populated with image information when this instance of the PdfRect object is one of the items of the collection returned by PdfPreview's ImageItems property. This property was introduced in Version 3.6.

For more information, see Section 17.8 - Image Replacement.


float Left (Read/Write)
Returns or specifies the X coordinate of the rectangle's lower-left corner.

float Right (Read/Write)
Returns or specifies the X coordinate of the rectangle's upper-right corner.

string Text (Read-only)

Returns the text fragment in Unicode format obtained during structured text extraction. Returns an empty string in all other cases. This property was introduced in Version 2.8.

For more information, see Section 17.7 - Structured Text Extraction.


float Top (Read/Write)
Returns or specifies the Y coordinate of the rectangle's upper-right corner.

float Width (Read/Write)
Returns or specifies rectangle's width which is computed as an absolute difference between its Right and Left properties. Setting this property has a side effect of modifying the Right property.

Methods


void Set(float X, float Y, float Width, float Height)
Sets the coordinates of the lower-left corner of the rectangle to (X, Y) and size to (Width, Height).

void SetRect(PdfRect Rect)
Copies the rectangle's coordinates and size from that of Rect.