DL Logo

PDEContainer Typedefs

PDEContainer

Header: PEExpT.h:248

Description

A group of PDEElement objects on a page in a PDF file. In the PDF file, containers are delimited by Marked Content BMC/EMC or BDC/EMC pairs. Every PDEContainer has a Marked Content tag associated with it. In addition to grouping a set of elements, a BDC/EMC pair specifies a property list to be associated with the grouping. Thus, a PDEContainer corresponding to a BDC/EMC pair also has a property list dictionary associated with it.

Related Methods

Syntax

typedef struct _t_PDEContainer *PDEContainer;

Returned From

Used By

Used In

PDEContainer Functions

PDEContainerCreate

Header: PEWProcs.h:1192

Description

Creates a container object.

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

Related Methods

PDEContainerGetMCTag PDEContainerSetMCTag

Syntax

PDEContainer PDEContainerCreate(IN ASAtom mcTag, IN CosObj *cosObjP, IN ASBool isInline);

Parameters

mcTag
IN/OUT The tag name for the container.
cosObjP
IN/OUT An optional Marked Content dictionary for the container.
isInline
If true, it emits the container's dictionary into the content stream inline. If false, then the dictionary is emitted outside of the content stream and referenced by name. See the Property Lists section of the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 14.6.2, page 554. This document is provided on the web site of the International Standards Organization (ISO).

Returns

The newly created container object.

Exceptions

PDEContainerGetContent

Header: PERProcs.h:1447

Description

Gets the PDEContent for a PDEContainer.

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

Related Methods

Syntax

PDEContent PDEContainerGetContent(IN PDEContainer pdeContainer);

Parameters

pdeContainer
IN/OUT The container whose content is obtained.

Returns

The PDEContent for the pdeContainer.

Exceptions

PDEContainerGetDict

Header: PERProcs.h:1431

Description

Gets the Marked Content dictionary for a container.

Related Methods

Syntax

ASBool PDEContainerGetDict(IN PDEContainer pdeContainer, OUT CosObj *placeDictP, OUT ASBool *isInline);

Parameters

pdeContainer
IN/OUT A container.
placeDictP
IN/OUT (Filled by the method) The Marked Content dictionary for pdeContainer. NULL if pdeContainer has no Marked Content dictionary.
isInline
IN/OUT (Filled by the method) true if the dictionary is inline, false otherwise. It is undefined if pdeContainer has no Marked Content dictionary.

Returns

true if pdeContainer has a Marked Content dictionary, false otherwise.

Exceptions

PDEContainerGetMCTag

Header: PERProcs.h:1412

Description

Gets the Marked Content tag for a container.

Related Methods

PDEContainerCreate PDEContainerSetMCTag

Syntax

ASAtom PDEContainerGetMCTag(IN PDEContainer pdeContainer);

Parameters

pdeContainer
IN/OUT A container.

Returns

The Marked Content tag of pdeContainer. It returns ASAtomNull if pdeContainer has no Marked Content tag.

Exceptions

PDEContainerSetContent

Header: PEWProcs.h:1245

Description

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

Note: This method decrements the reference count of the previous content of the container and increments the reference count of the new PDEContent.

Related Methods

Syntax

void PDEContainerSetContent(IN PDEContainer pdeContainer, IN PDEContent pdeContent);

Parameters

pdeContainer
IN/OUT A container.
pdeContent
IN/OUT The content of pdeContainer.

Exceptions

PDEContainerSetDict

Header: PEWProcs.h:1228

Description

Sets the Marked Content dictionary for a PDEContainer. The dictionary can be emitted inline or referenced from the \\Properties key in the \\Resources dictionary of the containing stream.

Related Methods

Syntax

void PDEContainerSetDict(IN PDEContainer pdeContainer, IN CosObj *placeDictP, IN ASBool isInline);

Parameters

pdeContainer
The container whose dictionary is changed.
placeDictP
The Marked Content dictionary being set into pdeContainer.
isInline
If true, it emits the container's dictionary into the content stream inline. If false, then the dictionary is emitted outside of the content stream and referenced by name. See the Property Lists section of the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 14.6.2, page 554. This document is provided on the web site of the International Standards Organization (ISO).

Exceptions

PDEContainerSetMCTag

Header: PEWProcs.h:1205

Description

Sets the Marked Content tag for a PDEContainer.

Related Methods

PDEContainerCreate PDEContainerGetMCTag

Syntax

void PDEContainerSetMCTag(IN PDEContainer pdeContainer, IN ASAtom mcTag);

Parameters

pdeContainer
IN/OUT The container to tag.
mcTag
IN/OUT The Marked Content tag.

Exceptions