Foxit PDF SDK
FSDK.StructMarkedContent Class Reference
Inheritance diagram for FSDK.StructMarkedContent:
FSDK.StructTreeEntity

Public Member Functions

 constructor ()
 Constructor.
 
 GetMCID ()
 Get marked-content identifier(MCID). More...
 
 GetParentElement ()
 Get the parent structure element. More...
 
 GetStmDict ()
 Get PDF dictionary of the content stream that contains the marked-content sequence. More...
 
 GetStmOwnerDict ()
 Get PDF dictionary of content stream owner. More...
 
- Public Member Functions inherited from FSDK.StructTreeEntity
 constructor ()
 Constructor.
 
 GetPage ()
 Get the related PDF page. More...
 
 GetType ()
 Get structure tree entity type. More...
 
 IsEmpty ()
 Check whether current object is empty or not. More...
 

Additional Inherited Members

- Static Public Attributes inherited from FSDK.StructTreeEntity
static e_StructTreeEntityTypeElement
 Structure tree entity type: Element, which represents a structure element.
 
static e_StructTreeEntityTypeMarkedContent
 Structure tree entity type: MarkedContent, which represents a marked-content item.
 
static e_StructTreeEntityTypeObjectContent
 Structure tree entity type: objectContent, which represents a PDF object content item, such as annotation and XObject.
 
static e_UnknownType
 Enumeration for structure tree entity type. More...
 

Detailed Description

This class represents a marked-content item.

Member Function Documentation

◆ GetMCID()

FSDK.StructMarkedContent.GetMCID ( )

Get marked-content identifier(MCID).

Returns
Marked-content identifier.

◆ GetParentElement()

FSDK.StructMarkedContent.GetParentElement ( )

Get the parent structure element.

Returns
Parent structure element. If function FSDK.StructElement.IsEmpty for the returned object returns true, that means current element does not have a parent element.

◆ GetStmDict()

FSDK.StructMarkedContent.GetStmDict ( )

Get PDF dictionary of the content stream that contains the marked-content sequence.

The content stream containing the marked-content sequence. This entry should be present only if the marked-content sequence resides in a content stream other than the content stream for the page.

Returns
PDF dictionary of content stream that contains the marked-content sequence.

◆ GetStmOwnerDict()

FSDK.StructMarkedContent.GetStmOwnerDict ( )

Get PDF dictionary of content stream owner.

Returns
PDF dictionary of content stream owner.