PDFEdit_Layer.PDEForm (Acrobat)

	Typedef
	PDEForm 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.

	Method
	PDEXGroup PDEFormAcquireXGroup(INPDEForm pdeForm) Acquires the transparency group dictionary of the XObject form.
	PDEForm PDEFormCreateClone(INPDEForm form) Creates a new form from an existing form object. Creates a copy of the PDEForm, including the underlying CosStream.
	PDEForm PDEFormCreateFromCosObj(const CosObj* xObjectP, const CosObj* resourcesP, INASFixedMatrixP matrixP) Superseded by PDEFormCreateFromCosObjEx() in Acrobat 10.0.
	PDEForm PDEFormCreateFromCosObjEx(const CosObj* xObjectP, const CosObj* resourcesP, INASDoubleMatrixP matrixP) Supersedes PDEFormCreateFromCosObj() in Acrobat 10.0.
	void PDEFormGetBBox(INPDEForm form, OUTASFixedRectP bboxP) 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.
	PDEContent PDEFormGetContent(INPDEForm form) Gets a PDEContent object for a form.
	ASUns32 PDEFormGetContentToCosObjFlags(INPDEForm form) Retrieves the PDEContentToCosObjFlags for this form. The flags were previously set by PDEFormSetContentToCosObjFlags() .
	void PDEFormGetCosObj(INPDEForm form, OUTCosObj* cosObjP) Gets a Cos object for a form.
	void PDEFormGetMatrix(INPDEForm form, OUTASFixedMatrixP matrixP) Superseded by PDEFormGetMatrixEx() in Acrobat 10.0.
	void PDEFormGetMatrixEx(INPDEForm form, OUTASDoubleMatrixP matrixP) Supersedes PDEFormGetMatrix() in Acrobat 10.0.
	ASBool PDEFormHasXGroup(INPDEForm pdeForm) Determines whether the XObject form has a Transparency XGroup
	void PDEFormSetContent(INPDEForm form, INPDEContent content) Sets the underlying CosStream of the form using the specified content object.
	void PDEFormSetContentToCosObjFlags(INPDEForm form, INASUns32 flags) Sets the PDEContentToCosObjFlags for this form.
	void PDEFormSetXGroup(INPDEForm pdeForm, INPDEXGroup pdeXGroup) Sets the transparency group dictionary of the form XObject.

Typedefs Detail

PDEForm

Product availability: All

Platform availability: All

Syntax

typedef struct _t_PDEForm* PDEForm;

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.

File: PEExpT.h

Line: 199

Method Detail

PDEFormAcquireXGroup

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDEXGroup PDEFormAcquireXGroup(INPDEForm pdeForm)

Acquires the transparency group dictionary of the XObject form.

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

Parameters

pdeForm —

IN/OUT The from.

Returns

The transparency group object.

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h

Line: 2208

PDEFormCreateClone

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDEForm PDEFormCreateClone(INPDEForm form)

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.

Parameters

form —

The form object from which a new PDEForm is created.

Returns

The newly created form object.

See Also

PDEFormCreateFromCosObj

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00060000

File: PEWProcs.h

Line: 2863

PDEFormCreateFromCosObj

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDEForm PDEFormCreateFromCosObj(const CosObj* xObjectP, const CosObj* resourcesP, INASFixedMatrixP matrixP)

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.

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.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

File: PEWProcs.h

Line: 813

PDEFormCreateFromCosObjEx

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDEForm PDEFormCreateFromCosObjEx(const CosObj* xObjectP, const CosObj* resourcesP, INASDoubleMatrixP matrixP)

Supersedes PDEFormCreateFromCosObj() 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.

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.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x000A0000

File: PEWProcs.h

Line: 4111

PDEFormGetBBox

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDEFormGetBBox(INPDEForm form, OUTASFixedRectP bboxP)

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.

Parameters

	`form` —	The PDEForm for which the bounding box is required.

	`bboxP` —	The resulting bounding box.

See Also

PDEElementGetBBox
PDEFormGetMatrix

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00070005

File: PEWProcs.h

Line: 3085

PDEFormGetContent

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDEContent PDEFormGetContent(INPDEForm form)

Gets a PDEContent object for a form.

Parameters

form —

The form whose content is obtained.

Returns

The content for form.

Exceptions

peErrWrongPDEObjectType
peErrPStackUnderflow

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

File: PEWProcs.h

Line: 828

PDEFormGetContentToCosObjFlags

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASUns32 PDEFormGetContentToCosObjFlags(INPDEForm form)

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

Parameters

form

Returns

Since

PI_PDFEDIT_READ_VERSION >= 0x00090000

File: PERProcs.h

Line: 3317

PDEFormGetCosObj

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDEFormGetCosObj(INPDEForm form, OUTCosObj* cosObjP)

Gets a Cos object for a form.

Parameters

	`form` —	IN/OUT The form whose Cos object is obtained.

	`cosObjP` —	IN/OUT (Filled by the method) The Cos object for the form.

See Also

PDEFormCreateFromCosObj

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h

Line: 1093

PDEFormGetMatrix

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDEFormGetMatrix(INPDEForm form, OUTASFixedMatrixP matrixP)

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.

Parameters

	`form` —	The form for which the matrix is required.

	`matrixP` —	The resultant matrix.

See Also

PDEElemetGetMatrix
PDEFormGetBBox
PDEFormGetMatrixEx

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00070005

File: PEWProcs.h

Line: 3068

PDEFormGetMatrixEx

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDEFormGetMatrixEx(INPDEForm form, OUTASDoubleMatrixP matrixP)

Supersedes PDEFormGetMatrix() 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.

Parameters

	`form` —	The form for which the matrix is required.

	`matrixP` —	The resultant matrix.

See Also

PDEElemetGetMatrix
PDEFormGetBBox
PDEFormGetMatrix

Since

PI_PDFEDIT_WRITE_VERSION >= 0x000A0000

File: PEWProcs.h

Line: 3607

PDEFormHasXGroup

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PDEFormHasXGroup(INPDEForm pdeForm)

Determines whether the XObject form has a Transparency XGroup

Parameters

pdeForm —

IN/OUT The form.

Returns

true if the XObject form has a Transparency XGroup.

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h

Line: 2220

PDEFormSetContent

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDEFormSetContent(INPDEForm form, INPDEContent content)

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

Parameters

	`form` —	The form whose content is set.

	`content` —	The new content for `form`.

See Also

PDEFormGetContent

Exceptions

peErrWrongPDEObjectType
peErrPStackUnderflow

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00060000

File: PEWProcs.h

Line: 2850

PDEFormSetContentToCosObjFlags

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDEFormSetContentToCosObjFlags(INPDEForm form, INASUns32 flags)

Sets the PDEContentToCosObjFlags for this form.

Parameters

	`form`

	`flags`

Exceptions

genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00090000

File: PEWProcs.h

Line: 3586

PDEFormSetXGroup

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDEFormSetXGroup(INPDEForm pdeForm, INPDEXGroup pdeXGroup)

Sets the transparency group dictionary of the form XObject.

Parameters

	`pdeForm` —	IN/OUT The font XObject.

	`pdeXGroup` —	IN/OUT The transparency dictionary.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h

Line: 2010

Acrobat API Reference	All Layers \| All Objects \| Index \| Samples \| Frames No Frames
PDEForm	Typedefs \| Methods

Layer	PDFEdit_Layer
Object	PDEForm