DL Logo

PDSMC Typedefs

PDSMC

Header: PDSExpT.h:117

Description

Represents marked content, which are portions of the graphic content of a PDF document that may be included in the document's logical structure hierarchy. This type is identical with the PDFEdit layer type PDEContainer.

Note: The write functions in the PDSEdit API are not available in Adobe Reader.

Syntax

typedef PDEContainer PDSMC;

Used By

PDSMCR

Header: PDSExpT.h:109

Description

* PDSMCR

Syntax

typedef CosObj PDSMCR;

PDSMC Structures

_t_PDSMCInfo

Header: PDSExpT.h:190

Description

Information about how a marked content PDS object (a marked content kid) is included in its parent.

Syntax

struct _t_PDSMCInfo {
ASSize_t size;
The size of this data structure.
ASInt32 mcid;
The MCID of the content kid in question.
ASBool directContent;
If true, content is contained within the page's content stream, and the fields containingStm and stmOwner are meaningless. If false, content is contained within some other content stream, such as a Form XObject or an annotation.
CosObj containingStm;
The stream object containing the marked content in question.
CosObj stmOwner;
The object owning the stream, as defined by the StmOwn key in an OBJR.
CosObj page;
The page on which the marked content is drawn, whether directly as part of page content or indirectly by being in a Form XObject or annotation drawn on that page.
} PDSMCInfo, *PDSMCInfoP;

Used By

PDSMC Functions

PDSMCGetInfo

Header: PDSReadProcs.h:765

Description

Gets information about how the specified marked content is contained in its parent.

Note: This method cannot access marked content inside a Form XObject.

Syntax

void PDSMCGetInfo(CosObj containingObj, PDSMC mc, PDSMCInfoP info);

Parameters

containingObj
The CosObj containing the MC whose information is obtained. For marked content on a page, this is the Cos object representing the page. For marked content elsewhere, this is the stream in which the marked content resides.
mc
The marked content whose information is obtained.
info
(Filled by the method) A pointer to a structure that the method fills with information about containingObj.

Exceptions

is raised if an error is found in the PDF file. It will also raise the error if the PDSMC passed to it is not in the structure tree.

PDSMCGetPDEContainer

Header: PDSReadProcs.h:795

Description

Gets the PDE container object for the specified marked content.

Syntax

PDEContainer PDSMCGetPDEContainer(PDSMC mc);

Parameters

mc
The marked content whose container is obtained.

Returns

The PDE container object.

PDSMCGetParent

Header: PDSReadProcs.h:503

Description

Gets the parent element of the specified marked content.

Syntax

void PDSMCGetParent(IN CosObj containingObj, IN PDSMC mc, OUT PDSElement *parent);

Parameters

containingObj
The CosObj containing the MC whose parent is obtained. For marked content on a page, this is the Cos object representing the page. For marked content elsewhere, this is the stream in which the marked content resides.
mc
The marked content whose parent is obtained.
parent
(Filled by the method) The parent element of containingObj.

Exceptions

is raised if an error is found in the PDF file. It will also raise the error if the PDSMC passed to it is not in the structure tree.

PDSMCIDGetParent

Header: PDSReadProcs.h:787

Description

Gets the parent element of the specified marked content, referred to by its containing object and marked-content identifier.

Syntax

ASBool PDSMCIDGetParent(ASInt32 mcid, CosObj containingObj, PDSElement *parent);

Parameters

mcid
The identifier (MCID) of the marked content whose parent is obtained.
containingObj
The CosObj containing the marked content whose parent is obtained. For marked content on a page, this is the Cos object representing the page. For marked content elsewhere, this is the stream in which the marked content resides.
parent
(Filled by the method) The parent element of containingObj.

Returns

true if the parent is successfully obtained, false otherwise.

Exceptions

is raised if an error is found in the PDF file. It will also raise the error if the PDSMC passed to it is not in the structure tree.

PDSMCRefCreate

Header: PDSWriteProcs.h:872

Description

Creates a reference handle to a piece of marked content that can be used to associate the content with structure. The handle can persist beyond the lifetime of the marked contents, allowing greater flexibility about when structure information can be created.

This may raise various exceptions.

Note: This must be called before placing the container within the content stream that owns it.

Note: The handle will persist until PDSMCRefDestroy is called.

Note: All values in the PDSMCInfo object apart from mcid are currently ignored.

Syntax

PDSMCRef PDSMCRefCreate(IN PDEElement container, IN CosDoc cosDoc, IN ASInt32 mcid);

Parameters

container
The marked content to create a reference for. It must be either a PDEContainer or PDEBeginContainer.
cosDoc
The document within which the reference will be used.
mcid
The mcid to set for the container.