PDFEdit_Layer.PDEXGroup (Acrobat)

	Typedef
	PDEXGroup A transparency (XGroup) resource.

	Enumeration
	`PDEXGroupCreateFlags` An enumerated data type used to specify the type of transparency group to create.

	Method
	PDEColorSpace PDEXGroupAcquireColorSpace(INPDEXGroup pdeXGroup) Acquires the color space of the transparency group.
	PDEXGroup PDEXGroupCreate(INCosDoc cosDoc, INPDEXGroupCreateFlags type) Create a new XGroup of the given type.
	PDEXGroup PDEXGroupCreateFromCosObj(const CosObj* cosObjP) Creates a new XGroup object from its Cos representation.
	void PDEXGroupGetCosObj(INPDEXGroup pdeXGroup, OUTCosObj* cosObjP) Gets the CosObj of the transparency group.
	ASBool PDEXGroupGetIsolated(INPDEXGroup pdeXGroup) Gets the isolated boolean value of the transparency group.
	ASBool PDEXGroupGetKnockout(INPDEXGroup pdeXGroup) Gets the knockout boolean value of the transparency group.
	void PDEXGroupSetColorSpace(INPDEXGroup pdeXGroup, INPDEColorSpace pdeColorSpace) Sets the PDEXObject that defines the color space into which colors are converted when painted into this group.
	void PDEXGroupSetIsolated(INPDEXGroup pdeXGroup, INASBool isolated) Sets the XGroup to be isolated or not. It corresponds to the / I key within the XGroup's dictionary.
	void PDEXGroupSetKnockout(INPDEXGroup pdeXGroup, INASBool knockout) Sets the knockout value.

Typedefs Detail

PDEXGroup

Product availability: All

Platform availability: All

Syntax

typedef struct _t_PDEXGroup* PDEXGroup;

A transparency (XGroup) resource.

See Also

PDESoftMaskCreate

File: PEExpT.h

Line: 1830

Elements

kPDEXGroupTypeTransparency

Creates a transparency XGroup object.

Method Detail

PDEXGroupAcquireColorSpace

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDEColorSpace PDEXGroupAcquireColorSpace(INPDEXGroup pdeXGroup)

Acquires the color space of the transparency group.

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

Parameters

pdeXGroup —

The transparency group object.

Returns

The color space; otherwise it returns NULL.

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h

Line: 2195

PDEXGroupCreate

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDEXGroup PDEXGroupCreate(INCosDoc cosDoc, INPDEXGroupCreateFlags type)

Create a new XGroup of the given type.

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

Parameters

	`cosDoc` —	The document in which the object will be created.

	`type` —	It must be kPDEXGroupTypeTransparency.

Returns

The newly created transparency group object.

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PEWProcs.h

Line: 1962

PDEXGroupCreateFromCosObj

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDEXGroup PDEXGroupCreateFromCosObj(const CosObj* cosObjP)

Creates a new XGroup object from its Cos representation.

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

Parameters

cosObjP —

IN/OUT The XGroup object dictionary.

Returns

The PDEXGroup object.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h

Line: 1949

PDEXGroupGetCosObj

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDEXGroupGetCosObj(INPDEXGroup pdeXGroup, OUTCosObj* cosObjP)

Gets the CosObj of the transparency group.

Parameters

	`pdeXGroup` —	The transparency group object.

	`cosObjP` —	(Filled by the method) A pointer to the Cos object.

Exceptions

genErrBadParm
peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h

Line: 2161

PDEXGroupGetIsolated

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PDEXGroupGetIsolated(INPDEXGroup pdeXGroup)

Gets the isolated boolean value of the transparency group.

Parameters

pdeXGroup —

The transparency group object.

Returns

true if the transparency group is isolated; false otherwise.

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h

Line: 2185

PDEXGroupGetKnockout

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PDEXGroupGetKnockout(INPDEXGroup pdeXGroup)

Gets the knockout boolean value of the transparency group.

Parameters

pdeXGroup —

The transparency group object.

Returns

The knockout value.

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h

Line: 2173

PDEXGroupSetColorSpace

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDEXGroupSetColorSpace(INPDEXGroup pdeXGroup, INPDEColorSpace pdeColorSpace)

Sets the PDEXObject that defines the color space into which colors are converted when painted into this group.

Parameters

	`pdeXGroup` —	The transparency group object.

	`pdeColorSpace` —	The color space to associate with the XGroup.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h

Line: 1998

PDEXGroupSetIsolated

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDEXGroupSetIsolated(INPDEXGroup pdeXGroup, INASBool isolated)

Sets the XGroup to be isolated or not. It corresponds to the / I key within the XGroup's dictionary.

Parameters

	`pdeXGroup` —	IN/OUT The transparency group object.

	`isolated` —	IN/OUT `true` to isolate the XGroup, `false` otherwise.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h

Line: 1986

PDEXGroupSetKnockout

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDEXGroupSetKnockout(INPDEXGroup pdeXGroup, INASBool knockout)

Sets the knockout value.

Parameters

	`pdeXGroup` —	IN/OUT The transparency group object.

	`knockout` —	IN/OUT The knockout value.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h

Line: 1973

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

Layer	PDFEdit_Layer
Object	PDEXGroup