MarkedContent Class Reference

Inheritance diagram for MarkedContent:

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...
Public Member Functions inherited from NativeObjectWrapper
	constructor (r)
	GetPointerAsNumber ()

Detailed Description

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 GraphicsObject.GetMarkedContent.

See also

GraphicsObject

Examples

/Users/ec2-user/gitlab-runner/builds/E-xKdhDo/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

Member Function Documentation

AddItem()

MarkedContent.AddItem	(	tag_name	,
		property_dict
	)

Add a new marked content item.

Parameters

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

Returns

The index of the newly added marked content item. If there is any error, this function will return -1.

GetItemCount()

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.

Returns

The count of marked content items.

GetItemMCID()

MarkedContent.GetItemMCID

(

index

)

Get marked-content identifier (MCID) of a marked content item specified by index.

Parameters

[in]

index

Item index. Valid range: from 0 to (count-1). count is returned by functionMarkedContent.GetItemCount.

Returns

The MCID value. A negative number means that the specified marked content item does not have a MCID.

GetItemPropertyDict()

MarkedContent.GetItemPropertyDict

(

index

)

Get the property dictionary of a marked content item specified by index.

Parameters

[in]

index

Item index. Valid range: from 0 to (count-1). count is returned by functionMarkedContent.GetItemCount.

Returns

The property dictionary. null means no property dictionary.

GetItemTagName()

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.

Parameters

[in]

index

Item index. Valid range: from 0 to (count-1). count is returned by functionMarkedContent.GetItemCount.

Returns

The tag name.

HasTag()

MarkedContent.HasTag

(

tag_name

)

Check whether current marked content object has a specified marked content item or not.

Parameters

[in]

tag_name

The tag name to be checked.

Returns

true means current marked content object has the specified marked content item. false means current marked content object does not have the specified marked content item.

RemoveItem()

MarkedContent.RemoveItem

(

tag_name

)

Remove a marked content item by tag name.

Parameters

[in]

tag_name

Tag name. It should not be an empty string.

Returns

true means success, while false means failure.