LayerPDFEdit_Layer
ObjectPDEGroup

An in-memory representation of objects in a PDEContent. It has no state and is not represented in any way in a PDF content stream (a PDEContent object).

When used in a PDEClip, this object is used to associate PDEText objects into a single clipping object. PDEBeginGroup and PDEEndGroup methods can be used to build the group incrementally in a PDEContent object.


Typedef Summary
 Typedef
 PDEBeginGroup
A group of PDEElement objects on a page in a PDF file.
 PDEEndGroup
A group of PDEElement objects on a page in a PDF file.
 PDEGroup
An in-memory representation of objects in a PDEContent object. It has no state and is not represented in any way in a PDF content stream (that is, PDEContent). When used in a PDEClip, this object is used to associate PDEText objects into a single clipping object.
Method Summary
 Method
 
PDEBeginGroup PDEBeginGroupCreate()
Creates a new begin group object.
 
PDEEndGroup PDEEndGroupCreate()
Creates a new end group object.
 
PDEGroup PDEGroupCreate()
Creates a PDEGroup object.
 
PDEContent PDEGroupGetContent(INPDEGroup pdeGroup)
Gets the PDEContent for a PDEGroup.
 
void PDEGroupSetContent(INPDEGroup pdeGroup, INPDEContent pdeContent)
Sets the PDEContent for a PDEGroup. The existing PDEContent is released by this method.

Typedefs Detail
PDEBeginGroup 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_PDEBeginGroup* PDEBeginGroup;

A group of PDEElement objects on a page in a PDF file.

See Also

PDEElement (superclass)
PDEBeginGroupCreate
PDERelease

File: PEExpT.h
Line: 285
PDEEndGroup 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_PDEEndGroup* PDEEndGroup;

A group of PDEElement objects on a page in a PDF file.

See Also

PDEElement (superclass)
PDEEndGroupCreate
PDERelease

File: PEExpT.h
Line: 292
PDEGroup 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_PDEGroup* PDEGroup;

An in-memory representation of objects in a PDEContent object. It has no state and is not represented in any way in a PDF content stream (that is, PDEContent). When used in a PDEClip, this object is used to associate PDEText objects into a single clipping object.

See Also

PDEElement (superclass)
PDEGroupCreate

File: PEExpT.h
Line: 254



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

Syntax

PDEBeginGroup PDEBeginGroupCreate()

Creates a new begin group object.

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

Returns

The newly created object.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h
Line: 2219
PDEEndGroupCreate() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

PDEEndGroup PDEEndGroupCreate()

Creates a new end group object.

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

Returns

The newly created object.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h
Line: 2228
PDEGroupCreate() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

PDEGroup PDEGroupCreate()

Creates a PDEGroup object.

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

Returns

The newly created PDEGroup.

See Also

PDEGroupSetContent

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

File: PEWProcs.h
Line: 1640
PDEGroupGetContent() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

PDEContent PDEGroupGetContent(INPDEGroup pdeGroup)

Gets the PDEContent for a PDEGroup.

Parameters

pdeGroup — 

IN/OUT The group whose content is obtained.

Returns

The PDEContent in pdeGroup.

See Also

PDEGroupSetContent

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

Note

This method does not change the reference count of the returned PDEContent.

File: PERProcs.h
Line: 1810
PDEGroupSetContent() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDEGroupSetContent(INPDEGroup pdeGroup, INPDEContent pdeContent)

Sets the PDEContent for a PDEGroup. The existing PDEContent is released by this method.

Parameters

pdeGroup — 

IN/OUT A container object.

 
pdeContent — 

IN/OUT The content to set for pdeGroup.

See Also

PDEGroupGetContent

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

Note

This method increments the reference count of pdeContent.

File: PEWProcs.h
Line: 1657



Copyright 2020 Adobe Systems Incorporated and its licensors. All rights reserved. Adobe and the Adobe logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. This product contains either BSAFE and/or TIPEM software by RSA Security, Inc. Portions utilize Microsoft Windows Media Technologies. Copyright © 2006 Microsoft Corporation. All Rights Reserved. Notices, terms and conditions pertaining to other third party software are located at http://www.adobe.com/go/thirdparty/ and incorporated herein by reference.
Wed Feb 7 2024, 2:16 pm IST