LayerPDFEdit_Layer
ObjectPDEPlace

A PDEPlace is a PDEElement that marks a place on a page. In a PDF file, a place is represented by the MP or DP marked content operators.

See Section 10.5, Marked Content, in the PDF Reference, for information on marked content.

A PDEPlace object allows marking a particular group of objects in a PDF file, rather than a place, with information.


Typedef Summary
 Typedef
 PDEPlace
A PDEElement that marks a place on a page in a PDF file. In a PDF file, a place is represented by the MP or DP Marked Content operators.
Method Summary
 Method
 
PDEPlace PDEPlaceCreate(INASAtom mcTag, INCosObj* cosObjP, INASBool isInline)
Creates a place object.
 
ASBool PDEPlaceGetDict(INPDEPlace pdePlace, OUTCosObj* placeDictP, OUTASBool* isInline)
Gets the Marked Content dictionary for a PDEPlace.
 
ASAtom PDEPlaceGetMCTag(INPDEPlace pdePlace)
Gets the Marked Content tag for a PDEPlace.
 
void PDEPlaceSetDict(INPDEPlace pdePlace, INCosObj* placeDictP, INASBool isInline)
Sets the Marked Content dictionary for a PDEPlace. The dictionary can be emitted inline or referenced from the \Properties key in the \Resources dictionary of the containing stream.
 
void PDEPlaceSetMCTag(INPDEPlace pdePlace, INASAtom mcTag)
Sets the Marked Content tag for a PDEPlace.

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

Syntax

typedef struct _t_PDEPlace* PDEPlace;

A PDEElement that marks a place on a page in a PDF file. In a PDF file, a place is represented by the MP or DP Marked Content operators.

Marked content is useful for adding structure information to a PDF file. For instance, a drawing program may want to mark a point with information, such as the start of a path of a certain type. Marked content provides a way to retain this information in the PDF file. A DP operator functions the same as the MP operator and, in addition, allows a property list dictionary to be associated with a place.

See Also

PDEElement (superclass)
PDEPlaceCreate
PDERelease

File: PEExpT.h
Line: 229



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

Syntax

PDEPlace PDEPlaceCreate(INASAtom mcTag, INCosObj* cosObjP, INASBool isInline)

Creates a place object.

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

Parameters

mcTag — 

IN/OUT The tag name for the place. It must not contain any white space characters (for example, spaces or tabs).

 
cosObjP — 

IN/OUT An optional Marked Content dictionary associated with the place.

 
isInline — 

If true, it emits the place'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 in the PDF Reference for more details.

Returns

The place object.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

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

Syntax

ASBool PDEPlaceGetDict(INPDEPlace pdePlace, OUTCosObj* placeDictP, OUTASBool* isInline)

Gets the Marked Content dictionary for a PDEPlace.

Parameters

pdePlace — 

IN/OUT The place whose Marked Content dictionary is obtained.

 
placeDictP — 

IN/OUT (Filled by the method) A pointer to the Marked Content dictionary; may be NULL.

 
isInline — 

IN/OUT (Filled by the method) If true, the Marked Content dictionary is inline; may be NULL.

Returns

true if dictionary is obtained, false if no dictionary is present.

See Also

PDEPlaceSetDict

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

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

Syntax

ASAtom PDEPlaceGetMCTag(INPDEPlace pdePlace)

Gets the Marked Content tag for a PDEPlace.

Parameters

pdePlace — 

IN/OUT The place whose Marked Content tag is obtained.

Returns

A tag for pdePlace.

See Also

PDEPlaceSetMCTag

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

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

Syntax

void PDEPlaceSetDict(INPDEPlace pdePlace, INCosObj* placeDictP, INASBool isInline)

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

Parameters

pdePlace — 

IN/OUT The place whose Marked Content dictionary is set.

 
placeDictP — 

IN/OUT The Marked Content dictionary for pdePlace.
 
isInline — 

If true, it emits the place'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 in the PDF Reference for more details.

See Also

PDEPlaceGetDict

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

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

Syntax

void PDEPlaceSetMCTag(INPDEPlace pdePlace, INASAtom mcTag)

Sets the Marked Content tag for a PDEPlace.

Parameters

pdePlace — 

IN/OUT The place whose Marked Content tag is set.
 
mcTag — 

IN/OUT The tag for pdePlace.

See Also

PDEPlaceGetMCTag

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

File: PEWProcs.h
Line: 1265



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