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.
typedef struct _t_PDEPlace *PDEPlace; Creates a place object.
Call PDERelease() to dispose of the returned place object when finished with it.
PDEPlace PDEPlaceCreate(IN ASAtom mcTag, IN CosObj *cosObjP, IN ASBool isInline); 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 of the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 14.6.2, page 554. You can find this document on the web store of the International Standards Organization (ISO). |
ASBool PDEPlaceGetDict(IN PDEPlace pdePlace, OUT CosObj *placeDictP, OUT ASBool *isInline); 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 |
ASAtom PDEPlaceGetMCTag(IN PDEPlace pdePlace); pdePlace | IN/OUT The place whose Marked Content tag is obtained.
|
pdePlace. \\Properties key in the \\Resources dictionary of the containing stream. void PDEPlaceSetDict(IN PDEPlace pdePlace, IN CosObj *placeDictP, IN ASBool isInline); 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 of the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 14.6.2, page 554. You can find this document on the web store of the International Standards Organization (ISO). |
void PDEPlaceSetMCTag(IN PDEPlace pdePlace, IN ASAtom mcTag); pdePlace | IN/OUT The place whose Marked Content tag is set.
|
mcTag | IN/OUT The tag for
pdePlace. |