DL Logo

PDEForm Typedefs

PDEForm

Header: PEExpT.h:202

Description

A PDEElement that corresponds to an instance of an XObject Form on a page (or another containing stream such as another XObject Form or annotation form). The context associated with this instance includes the actual CosObj stream that represents the XObject Form and the initial conditions of the graphics state. The latter consists of the transformation matrix, initial color values, and so forth. It is possible to have two PDEForm objects that refer to the same XObject Form. The forms will exist at different places on the same page, depending on the transformation matrix. They may also have different colors or line stroking parameters. In the case of a transparency group, the opacity is specified in the gstate. Within a PDEForm, each PDEElement has its own gstate (or is a container, place, or group object). These gstates are independent of the parent PDEForm gstate. PDEForm elements within the PDEForm may have their own opacity. A PDEContent may be obtained from a PDEForm to edit the form's display list.

Related Methods

Syntax

typedef struct _t_PDEForm *PDEForm;

Returned From

Used By

PDEForm Functions

PDEFormAcquireXGroup

Header: PERProcs.h:2014

Description

Acquires the transparency group dictionary of the XObject form.

Call PDERelease() to dispose of the PDEXGroup when finished with it.

Syntax

PDEXGroup PDEFormAcquireXGroup(IN PDEForm pdeForm);

Parameters

pdeForm
IN/OUT The from.

Returns

The transparency group object.

Exceptions

PDEFormCreateClone

Header: PEWProcs.h:2594

Description

Creates a new form from an existing form object. Creates a copy of the PDEForm, including the underlying CosStream.

Call PDERelease() to dispose of the returned PDEForm object when finished with it.

Related Methods

Syntax

PDEForm PDEFormCreateClone(IN PDEForm form);

Parameters

form
The form object from which a new PDEForm is created.

Returns

The newly created form object.

PDEFormCreateFromCosObj

Header: PEWProcs.h:744

Description

Superseded by PDEFormCreateFromCosObjEx() in Acrobat 10.0. Creates a new form from an existing Cos object.

Call PDERelease() to dispose of the returned form object when finished with it.

Syntax

PDEForm PDEFormCreateFromCosObj(IN const CosObj *xObjectP, IN const CosObj *resourcesP, IN ASFixedMatrixP matrixP);

Parameters

xObjectP
The Cos object from which a PDEForm is created.
resourcesP
The xObjectP parameter's Resources dictionary. If you do not pass in a Resource object, subsequent calls to PDPageAcquirePDEContent() will fail (after the file is saved).
matrixP
A pointer to an ASFixedMatrix that holds the transformation matrix to use for the form.

Returns

The newly created form object.

PDEFormCreateFromCosObjEx

Header: PEWProcs.h:3697

Description

Creates a new form from an existing Cos object. Supersedes PDEFormCreateFromCosObj() in Acrobat 10.0.

Call PDERelease() to dispose of the returned form object when finished with it.

Syntax

PDEForm PDEFormCreateFromCosObjEx(IN const CosObj *xObjectP, IN const CosObj *resourcesP, IN ASDoubleMatrixP matrixP);

Parameters

xObjectP
The Cos object from which a PDEForm is created.
resourcesP
The xObjectP parameter's Resources dictionary. If you do not pass in a Resource object, subsequent calls to PDPageAcquirePDEContent() will fail (after the file is saved).
matrixP
A pointer to an ASDoubleMatrix that holds the transformation matrix to use for the form.

Returns

The newly created form object.

PDEFormGetBBox

Header: PEWProcs.h:2793

Description

Gets the bounding box for a PDEform. The result is the concatenation of the CTM and the Cos level form matrix applied on cos level bounding box. The returned bounding box is guaranteed to encompass the PDEForm, but is not guaranteed to be the smallest box that could contain the form object. Note: For other elements, PDEElementGetBBox() would return the correct bounding box values.

Syntax

void PDEFormGetBBox(IN PDEForm form, OUT ASFixedRectP bboxP);

Parameters

form
The PDEForm for which the bounding box is required.
bboxP
The resulting bounding box.

PDEFormGetContent

Header: PEWProcs.h:759

Description

Gets a PDEContent object for a form.

Note: Unlike other GetContent methods, this method does increment the reference count of the returned PDEContent. Call PDERelease() to dispose of the returned PDEContent object when finished with it.

Syntax

PDEContent PDEFormGetContent(IN PDEForm form);

Parameters

form
The form whose content is obtained.

Returns

The content for form.

Exceptions

PDEFormGetContentToCosObjFlags

Header: PERProcs.h:3021

Description

Retrieves the PDEContentToCosObjFlags for this form. The flags were previously set by PDEFormSetContentToCosObjFlags().

Syntax

ASUns32 PDEFormGetContentToCosObjFlags(IN PDEForm form);

PDEFormGetCosObj

Header: PERProcs.h:1007

Description

Gets a Cos object for a form.

Related Methods

Syntax

void PDEFormGetCosObj(IN PDEForm form, OUT CosObj *cosObjP);

Parameters

form
IN/OUT The form whose Cos object is obtained.
cosObjP
IN/OUT (Filled by the method) The Cos object for the form.

Exceptions

PDEFormGetLeading

Header: PERProcs.h:3466

Description

Gets the Leading set in parent of PDEForm element.

Related Methods

Syntax

ASDouble PDEFormGetLeading(IN PDEForm form);

Parameters

form
IN A form XObject object.

PDEFormGetMatrix

Header: PEWProcs.h:2778

Description

Superseded by PDEFormGetMatrixEx() in Acrobat 10.0. Gets the matrix for a PDEform.

The result is a concatenation of the CTM and the Cos level form matrix, resulting in the transformation from the form space to the device space.

Note: For the other elements, PDEElementGetMatrix() would give correct results.

Syntax

void PDEFormGetMatrix(IN PDEForm form, OUT ASFixedMatrixP matrixP);

Parameters

form
The form for which the matrix is required.
matrixP
The resultant matrix.

PDEFormGetMatrixEx

Header: PEWProcs.h:3258

Description

Gets the matrix for a PDEform. Supersedes PDEFormGetMatrix() in Acrobat 10.0.

The result is a concatenation of the CTM and the Cos level form matrix, resulting in the transformation from the form space to the device space.

Note: For the other elements, PDEElementGetMatrixEx() would give correct results.

Syntax

void PDEFormGetMatrixEx(IN PDEForm form, OUT ASDoubleMatrixP matrixP);

Parameters

form
The form for which the matrix is required.
matrixP
The resultant matrix.

PDEFormHasXGroup

Header: PERProcs.h:2025

Description

Determines whether the XObject form has a Transparency XGroup

Syntax

ASBool PDEFormHasXGroup(IN PDEForm pdeForm);

Parameters

pdeForm
IN/OUT The form.

Returns

true if the XObject form has a Transparency XGroup.

Exceptions

PDEFormIsLeadingSet

Header: PERProcs.h:3501

Description

Returns whether text leading is set in parent of PDEForm element or not.

Syntax

ASBool PDEFormIsLeadingSet(IN PDEForm form);

Parameters

form
IN A form XObject object.

PDEFormSetContent

Header: PEWProcs.h:2582

Description

Sets the underlying CosStream of the form using the specified content object.

Related Methods

Syntax

void PDEFormSetContent(IN PDEForm form, IN PDEContent content);

Parameters

form
The form whose content is set.
content
The new content for form.

Exceptions

PDEFormSetContentToCosObjFlags

Header: PEWProcs.h:3241

Description

Sets the PDEContentToCosObjFlags for this form.

Syntax

void PDEFormSetContentToCosObjFlags(IN PDEForm form, IN ASUns32 flags);

Exceptions

PDEFormSetLeading

Header: PEWProcs.h:3866

Description

Sets the Leading in parent of PDEForm element before form emit.

Related Methods

Syntax

void PDEFormSetLeading(IN PDEForm form, IN ASDouble Leading);

Parameters

form
IN A form XObject object.
ASDouble
IN Leading in gstate of parent of form XObject.

PDEFormSetXGroup

Header: PEWProcs.h:1832

Description

Sets the transparency group dictionary of the form XObject.

Syntax

void PDEFormSetXGroup(IN PDEForm pdeForm, IN PDEXGroup pdeXGroup);

Parameters

pdeForm
IN/OUT The font XObject.
pdeXGroup
IN/OUT The transparency dictionary.