LayerPD_Layer
ObjectPDForm

A PDForm is a self-contained set of graphics operators that is used when a particular graphic is drawn more than once in a document. It corresponds to a form resource (see Section 4.9, Form XObjects, in the PDF Reference). PDForm objects inherit from the PDXObject class; you can use any PDXObject methods on a PDForm.



Method Summary
 Method
 
void PDFormEnumPaintProc(PDXObject obj, PDGraphicEnumMonitor mon, void* clientData)
(Obsolete, provided only for backwards compatibility) Enumerates a form's drawing operations.
 
Enumerates a form's drawing operations for those contents that are visible in a given optional-content context. The parameters include both the monitor and data you would pass to PDFormEnumPaintProc(), and an optional-content context that determines which contents are visible.
 
void PDFormEnumResources(PDXObject obj, PDResourceEnumMonitor mon, void* clientData)
(Obsolete, provided only for backwards compatibility) Enumerates the resources used by a form.
 
(Obsolete, provided only for backwards compatibility) Gets a form's bounding box.
 
(Obsolete, provided only for backwards compatibility) Gets the value of a form's FormType attribute.
 
(Obsolete, provided only for backwards compatibility) Gets the specified form's transformation matrix.
 
(Obsolete, provided only for backwards compatibility) Gets the array Cos object corresponding to a form's XUID. An XUID is an array of numbers that uniquely identify the form in order to allow it to be cached.




Method Detail
PDFormEnumPaintProc()
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDFormEnumPaintProc(PDXObject obj, PDGraphicEnumMonitor mon, void* clientData)

(Obsolete, provided only for backwards compatibility) Enumerates a form's drawing operations.

Parameters

obj — 

The form whose drawing operations are enumerated.

 
mon — 

A structure containing user-supplied callbacks that are called for each drawing operator on a page. Enumeration ends if any procedure returns false.

 
clientData — 

A pointer to user-supplied data to pass to mon each time it is called.

See Also

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3909
PDFormEnumPaintProcWithParams() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDFormEnumPaintProcWithParams(PDXObject obj, PDGraphicEnumParams params)

Enumerates a form's drawing operations for those contents that are visible in a given optional-content context. The parameters include both the monitor and data you would pass to PDFormEnumPaintProc(), and an optional-content context that determines which contents are visible.

Parameters

obj — 

The form whose drawing operations are enumerated.

 
params — 

The parameters, including the optional-content context to use for content visibility.

See Also

Exceptions

pdPErrUnableToCreateRasterPort

Since

PI_PDMODEL_VERSION >= 0x00060000

File: PDProcs.h
Line: 10416
PDFormEnumResources() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDFormEnumResources(PDXObject obj, PDResourceEnumMonitor mon, void* clientData)

(Obsolete, provided only for backwards compatibility) Enumerates the resources used by a form.

Parameters

obj — 

The form whose resources are enumerated.

 
mon — 

A structure containing user-supplied callbacks that are called for each of the form's resources. Enumeration ends if any procedure returns false.

 
clientData — 

A pointer to user-supplied data to pass to mon each time it is called.

See Also

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3892
PDFormGetBBox() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDFormGetBBox(PDXObject obj, ASFixedRect* bboxP)

(Obsolete, provided only for backwards compatibility) Gets a form's bounding box.

Parameters

obj — 

The form whose bounding box is obtained.

 
bboxP — 

(Filled by the method) A pointer to a rectangle containing the form's bounding box, specified in user space coordinates.

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3853
PDFormGetFormType() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 PDFormGetFormType(PDXObject obj)

(Obsolete, provided only for backwards compatibility) Gets the value of a form's FormType attribute.

Parameters

obj — 

The form whose type is obtained.

Returns

The form type (the value of the PDF FormType key). This value is 1 for PDF 1.0, 1.1, and 1.2.

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3842
PDFormGetMatrix() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDFormGetMatrix(PDXObject obj, ASFixedMatrix* matrixP)

(Obsolete, provided only for backwards compatibility) Gets the specified form's transformation matrix.

Parameters

obj — 

The form whose transformation matrix is obtained.

 
matrixP — 

(Filled by the method) A pointer to a matrix containing the form's transformation matrix, which specifies the transformation from form space to user space. See Section 4.9 in the PDF Reference.

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3866
PDFormGetXUIDCosObj() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

CosObj PDFormGetXUIDCosObj(PDXObject obj)

(Obsolete, provided only for backwards compatibility) Gets the array Cos object corresponding to a form's XUID. An XUID is an array of numbers that uniquely identify the form in order to allow it to be cached.

Parameters

obj — 

The form whose XUID is obtained.

Returns

The array Cos object for the form's XUID.

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3877