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

Public Member Functions

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

Additional Inherited Members

- Static Public Attributes inherited from FoxitPDFSDKPython2.StructTreeEntity
 e_StructTreeEntityTypeElement = _fsdk.StructTreeEntity_e_StructTreeEntityTypeElement
 Structure tree entity type: Element, which represents a structure element.

 
 e_StructTreeEntityTypeMarkedContent = _fsdk.StructTreeEntity_e_StructTreeEntityTypeMarkedContent
 Structure tree entity type: MarkedContent, which represents a marked-content item.

 
 e_StructTreeEntityTypeObjectContent = _fsdk.StructTreeEntity_e_StructTreeEntityTypeObjectContent
 Structure tree entity type: ObjectContent, which represents a PDF object content item, such as annotation and XObject.

 
 e_UnknownType = _fsdk.StructTreeEntity_e_UnknownType
 Structure tree entity type: unknown.

 

Detailed Description

This class represents a marked-content item.

Constructor & Destructor Documentation

◆ StructMarkedContent()

def FoxitPDFSDKPython2.StructMarkedContent.StructMarkedContent ( )

Constructor.

Constructor, with another structure marked-content object.

Parameters
[in]otherAnother structure marked-content object.

Member Function Documentation

◆ GetMCID()

def FoxitPDFSDKPython2.StructMarkedContent.GetMCID ( )

Get marked-content identifier(MCID).

Returns
Marked-content identifier.

◆ GetParentElement()

def FoxitPDFSDKPython2.StructMarkedContent.GetParentElement ( )

Get the parent structure element.

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

◆ GetStmDict()

def FoxitPDFSDKPython2.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()

def FoxitPDFSDKPython2.StructMarkedContent.GetStmOwnerDict ( )

Get PDF dictionary of content stream owner.

Returns
PDF dictionary of content stream owner.