Rect Class

Rect is a utility class used to manipulate PDF rectangle objects (refer to section 3.8.3 of the PDF Reference Manual). Rect can be associated with a SDF/Cos rectangle Array using Rect(Obj*) constructor or later using Rect::Attach(Obj*) or Rect::Update(Obj*) methods. Rect keeps a local cache for rectangle points so it is necessary to call Rect::Update() method if the changes to the Rect should be saved in the attached Cos/SDF Array.

Inheritance Hierarchy

SystemObject
pdftron.PDFRect

Namespace: pdftron.PDF
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255

Syntax

C++

JavaScript

Copy

public sealed class Rect : IClosable

Public NotInheritable Class Rect
	Implements IClosable

public ref class Rect sealed : IClosable

pdftron.PDF.Rect = function();

Type.createClass(
	'pdftron.PDF.Rect',
	null,
	Windows.Foundation.IClosable);

The Rect type exposes the following members.

Constructors

	Name	Description
	Rect	Rect default constructor.
	Rect(Obj)	Create a Rect and initialize it using given Cos/SDF rectangle Array object. The rect is attached to this object.
	Rect(Double, Double, Double, Double)	Creates a Rect and initialize it using specified parameters.

Top

Properties

	Name	Description
	x1	Gets or sets the x coordinate of the bottom left corner.
	x2	Gets or sets the x coordinate of the top right corner.
	y1	Gets or sets the y coordinate of the bottom left corner.
	y2	Gets or sets the y coordinate of the top right corner.

Top

Methods

	Name	Description
	Attach	Attaches the Cos/SDF object to the Rect.
	Close
	Contains	Determines if the specified point is contained within the rectangular region defined by this Rectangle.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Get	Gets the rectangle coordinates.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Height	Gets the height of this Rect.
	Inflate(Double)	Inflates this Rect.
	Inflate(Double, Double)	Inflates this Rect with the specified x and y values.
	IntersectRect	Makes a Rect equal to the intersection of two existing rectangles.
	Normalize	Normalizes the rectagle to the one with lower-left and upper-right corners.
	Set(Rect)	Set the coordinates of the rectangle.
	Set(Double, Double, Double, Double)	Sets the coordinates of the rectangle.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Update	Saves changes made to the Rect object in the attached (or specified) SDF/Cos rectangle.
	Update(Obj)	Saves changes made to the Rect object in the attached (or specified) SDF/Cos rectangle.
	Width	Gets the width of this Rect.

Top

Remarks

Although rectangles are conventionally specified by their lower-left and upper-right corners, it is acceptable to specify any two diagonally opposite corners.

Reference

pdftron.PDF Namespace