PDSEdit_Layer.PDSMC (Acrobat)

	Typedef
	PDSMC 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.
	PDSMCInfo
	PDSMCInfoP
	PDSMCR PDSMCR
	PDSMCRef An opaque pointer type to a marked content reference handle.

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

	Method
	void PDSMCGetInfo(CosObj containingObj, PDSMC mc, PDSMCInfoP info) Gets information about how the specified marked content is contained in its parent.
	void PDSMCGetParent(INCosObj containingObj, INPDSMC mc, OUTPDSElement* parent) Gets the parent element of the specified marked content.
	PDEContainer PDSMCGetPDEContainer(PDSMC mc) Gets the PDE container object for the specified marked content.
	ASBool PDSMCIDGetParent(ASInt32 mcid, CosObj containingObj, PDSElement* parent) Gets the parent element of the specified marked content, referred to by its containing object and marked-content identifier.
	PDSMCRef PDSMCRefCreate(INPDEElement container, INCosDoc cosDoc, INASInt32 mcid) 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.
	void PDSMCRefDestroy(INPDSMCRef ref) Destroys a marked content reference created with PDSMCRefCreate(). This should only be called once the reference has been placed in the structure tree or if the reference is no longer needed.

Typedefs Detail

PDSMC

Product availability: All

Platform availability: All

Syntax

typedef PDEContainer PDSMC;

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.

File: PDSExpT.h

Line: 123

PDSMCInfo

Product availability: All

Platform availability: All

Syntax

typedef _t_PDSMCInfo PDSMCInfo;

File: PDSExpT.h

Line: 223

PDSMCInfoP

Product availability: All

Platform availability: All

Syntax

typedef _t_PDSMCInfo PDSMCInfoP;

File: PDSExpT.h

Line: 223

PDSMCR

Product availability: All

Platform availability: All

Syntax

typedef CosObj PDSMCR;

PDSMCR

File: PDSExpT.h

Line: 114

PDSMCRef

Product availability: All

Platform availability: All

Syntax

typedef struct _t_PDSMCRef* PDSMCRef;

An opaque pointer type to a marked content reference handle.

File: PDSExpT.h

Line: 160

Structure Detail

_t_PDSMCInfo

Product availability: All

Platform availability: All

Syntax

struct _t_PDSMCInfo {

  ASSize_t size;  


 


  ASInt32 mcid;  


 


  ASBool directContent;  


 


  CosObj containingStm;  


 


  CosObj stmOwner;  


 


  CosObj page;  

}

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

See Also

PDSMCGetInfo

File: PDSExpT.h

Line: 203

Elements

	size	The size of this data structure.

	mcid	The MCID of the content kid in question.

	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.

	containingStm	The stream object containing the marked content in question.

	stmOwner	The object owning the stream, as defined by the StmOwn key in an OBJR.

	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 .

Method Detail

PDSMCGetInfo

()

Product availability: All

Platform availability: All

Syntax





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

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

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

pdsErrBadPDF 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.

Since

PI_PDS_READ_VERSION >= 0x00060000

File: PDSReadProcs.h

Line: 812

PDSMCGetParent

()

Product availability: All

Platform availability: All

Syntax





void PDSMCGetParent(INCosObj containingObj, INPDSMC mc, OUTPDSElement* parent)

Gets the parent element of the specified marked content.

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

pdsErrBadPDF 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.

Since

PI_PDS_READ_VERSION >= 0x00040000

File: PDSReadProcs.h

Line: 529

PDSMCGetPDEContainer

()

Product availability: All

Platform availability: All

Syntax





PDEContainer PDSMCGetPDEContainer(PDSMC mc)

Gets the PDE container object for the specified marked content.

Parameters

mc —

The marked content whose container is obtained.

Returns

The PDE container object.

Since

PI_PDS_READ_VERSION >= 0x00060000

File: PDSReadProcs.h

Line: 844

PDSMCIDGetParent

()

Product availability: All

Platform availability: All

Syntax





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

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

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.

See Also

PDSMCGetParent
PDSElementGetParent

Exceptions

pdsErrBadPDF 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.

Since

PI_PDS_READ_VERSION >= 0x00060000

File: PDSReadProcs.h

Line: 836

PDSMCRefCreate

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDSMCRef PDSMCRefCreate(INPDEElement container, INCosDoc cosDoc, INASInt32 mcid)

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.

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.

Returns

Since

PI_PDS_WRITE_VERSION >= 0x00070000

File: PDSWriteProcs.h

Line: 913

PDSMCRefDestroy

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDSMCRefDestroy(INPDSMCRef ref)

Destroys a marked content reference created with PDSMCRefCreate(). This should only be called once the reference has been placed in the structure tree or if the reference is no longer needed.

Parameters

ref —

The marked content reference to destroy.

Exceptions

Unknown

Since

PI_PDS_WRITE_VERSION >= 0x00070000

File: PDSWriteProcs.h

Line: 929

Acrobat API Reference	All Layers \| All Objects \| Index \| Samples \| Frames No Frames
PDSMC	Typedefs \| Structures \| Methods

	ASSize_t size;

	ASInt32 mcid;

	ASBool directContent;

	CosObj containingStm;

	CosObj stmOwner;

	CosObj page;

Layer	PDSEdit_Layer
Object	PDSMC