|
Foxit PDF SDK
|
Inherits FoxitPDFSDKPython2._object.
Public Member Functions | |
| def | AddItem (tag_name, property_dict) |
| Add a new marked content item. More... | |
| def | GetItemCount () |
| Get the count of marked content items. More... | |
| def | GetItemMCID (index) |
| Get marked-content identifier (MCID) of a marked content item specified by index. More... | |
| def | GetItemPropertyDict (index) |
| Get the property dictionary of a marked content item specified by index. More... | |
| def | GetItemTagName (index) |
| Get the tag name of a marked content item specified by index. More... | |
| def | HasTag (tag_name) |
| Check whether current marked content object has a specified marked content item or not. More... | |
| def | RemoveItem (tag_name) |
| Remove a marked content item by tag name. More... | |
Marked-content operators (PDF 1.2) identify a portion of a PDF content stream as a marked-content element of interest to a particular application or PDF plug-in extension. For more details, please refer to Section 10.5 "Marked Content" in <PDF Reference 1.7>.
To get a marked content object, please use function FoxitPDFSDKPython2.GraphicsObject.GetMarkedContent .
| def FoxitPDFSDKPython2.MarkedContent.AddItem | ( | tag_name, | |
| property_dict | |||
| ) |
Add a new marked content item.
| [in] | tag_name | New tag name. It should not be an empty string. If parameter tag_name exists in current marked content object, it cannot be added to current marked content object again. |
| [in] | property_dict | A property dictionary. Default value: null. null means the new marked content item will not have a property dictionary. If this dictionary is newly created and not set to other object yet, user should release this dictionary object after calling this function. |
| def FoxitPDFSDKPython2.MarkedContent.GetItemCount | ( | ) |
Get the count of marked content items.
A marked content object may be nested one within another, and this function is used to get the count of marked content items in the current marked content sequence.
| def FoxitPDFSDKPython2.MarkedContent.GetItemMCID | ( | index | ) |
Get marked-content identifier (MCID) of a marked content item specified by index.
| [in] | index | Item index. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython2.MarkedContent.GetItemCount . |
| def FoxitPDFSDKPython2.MarkedContent.GetItemPropertyDict | ( | index | ) |
Get the property dictionary of a marked content item specified by index.
| [in] | index | Item index. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython2.MarkedContent.GetItemCount . |
| def FoxitPDFSDKPython2.MarkedContent.GetItemTagName | ( | index | ) |
Get the tag name of a marked content item specified by index.
A marked content object may be nested one within another, and this function is used to get the count of marked content items in the current marked content sequence.
| [in] | index | Item index. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython2.MarkedContent.GetItemCount . |
| def FoxitPDFSDKPython2.MarkedContent.HasTag | ( | tag_name | ) |
Check whether current marked content object has a specified marked content item or not.
| [in] | tag_name | The tag name to be checked. |
| def FoxitPDFSDKPython2.MarkedContent.RemoveItem | ( | tag_name | ) |
Remove a marked content item by tag name.
| [in] | tag_name | Tag name. It should not be an empty string. |