DL Logo

PDEBeginContainer Typedefs

PDEBeginContainer

Header: PEExpT.h:273

Description

The PDFEdit representation of the opening bracket of a marked-content sequence. Elements of this type must be paired with elements of type PDEEndContainer.

Related Methods

Syntax

typedef struct _t_PDEBeginContainer *PDEBeginContainer;

Returned From

Used By

PDEBeginContainer Functions

PDEBeginContainerCreate

Header: PEWProcs.h:1669

Description

Creates a new PDEBeginContainer object. Call PDERelease to dispose of the returned PDEBeginContainer object when finished with it.

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

Syntax

PDEBeginContainer PDEBeginContainerCreate(IN ASAtom mcTag, IN CosObj *cosObjP, IN ASBool isInline);

Parameters

mcTag
IN/OUT The tag name for the marked-content sequence.
cosObjP
IN/OUT (May be NULL) A CosDict object containing the property list for the sequence.
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 object.

PDEBeginContainerGetDict

Header: PERProcs.h:1897

Description

Gets the property list dictionary associated with a PDEBeginContainer object. The property list is stored in a Cos dictionary.

Note: Either dictP or isInlineP may be NULL if that information is not required.

Syntax

ASBool PDEBeginContainerGetDict(IN PDEBeginContainer pdeBeginContainer, OUT CosObj *dictP, OUT ASBool *isInlineP);

Parameters

pdeBeginContainer
IN/OUT A PDEBeginContainer object.
dictP
IN/OUT (Filled by the method) The property list associated with the PDEBeginContainer.
isInlineP
IN/OUT (Filled by the method) If true, the dictionary is emitted into the page content stream inline.

Returns

true if dictP points to a Cos dictionary; false otherwise.

Exceptions

if pdeBeginContainer is NULL or not the right type.

PDEBeginContainerGetMCTag

Header: PERProcs.h:1877

Description

Gets the marked content tag associated with a PDEBeginContainer object.

Related Methods

Syntax

ASAtom PDEBeginContainerGetMCTag(IN PDEBeginContainer pdeBeginContainer);

Parameters

pdeBeginContainer
IN/OUT A PDEBeginContainer object.

Returns

The mark content tag.

Exceptions

if pdeBeginContainer is NULL or not the right type.

PDEBeginContainerSetDict

Header: PEWProcs.h:1707

Description

Sets the property list for a PDEBeginContainer. The property list is passed as a Cos dictionary that can be emitted inline or referenced from the \\Properties key in the \\Resources dictionary of the containing stream. To learn about Property Lists for isInline, see the ISO 32000-:2008 document (1.7). This document is provided on the web site of the International Standards Organization (ISO).

Note: If cosObjP is NULL, the property list is cleared.

Syntax

void PDEBeginContainerSetDict(IN PDEBeginContainer pdeBeginContainer, IN CosObj *pdeBeginContainerDictP, IN ASBool isInline);

Parameters

pdeBeginContainer
IN/OUT The PDEBeginContainer object.
pdeBeginContainerDictP
IN/OUT (May be NULL) The Cos dictionary containing the property list.
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.

Exceptions

is raised if pdeBeginContainer is NULL or not the right type.

PDEBeginContainerSetMCTag

Header: PEWProcs.h:1681

Description

Sets the marked content tag for a PDEBeginContainer.

Syntax

void PDEBeginContainerSetMCTag(IN PDEBeginContainer pdeBeginContainer, IN ASAtom mcTag);

Parameters

pdeBeginContainer
IN/OUT The PDEBeginContainer object.
mcTag
IN/OUT The tag name.

Exceptions

if pdeBeginContainer is NULL or is not the right type.