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


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

Height As Single (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.

ImageInfo As PdfParam (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.


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

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

Text As String (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.


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

Width As Single (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


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

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