Foxit PDF SDK
|
Public Member Functions | |
AddItem (tag_name, property_dict) | |
Add a new marked content item. More... | |
GetItemCount () | |
Get the count of marked content items. More... | |
GetItemMCID (index) | |
Get marked-content identifier (MCID) of a marked content item specified by index. More... | |
GetItemPropertyDict (index) | |
Get the property dictionary of a marked content item specified by index. More... | |
GetItemTagName (index) | |
Get the tag name of a marked content item specified by index. More... | |
HasTag (tag_name) | |
Check whether current marked content object has a specified marked content item or not. More... | |
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 FSDK.GraphicsObject.GetMarkedContent.
FSDK.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. |
FSDK.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.
FSDK.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 functionFSDK.MarkedContent.GetItemCount. |
FSDK.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 functionFSDK.MarkedContent.GetItemCount. |
FSDK.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 functionFSDK.MarkedContent.GetItemCount. |
FSDK.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. |
FSDK.MarkedContent.RemoveItem | ( | tag_name | ) |
Remove a marked content item by tag name.
[in] | tag_name | Tag name. It should not be an empty string. |