Inheritance diagram for foxit.addon.accessibility.TagTreeEditor:

Public Types
enum	ArtifactAttachToSideType { ArtifactAttachToSideType.e_ArtifactAttachToSideTypeNone = 0, ArtifactAttachToSideType.e_ArtifactAttachToSideTypeLeft = 1, ArtifactAttachToSideType.e_ArtifactAttachToSideTypeTop = 2, ArtifactAttachToSideType.e_ArtifactAttachToSideTypeRight = 3, ArtifactAttachToSideType.e_ArtifactAttachToSideTypeBottom = 4 }
	Enumeration for artifact attach-to-side type. More...

enum	ArtifactType { ArtifactType.e_ArtifactTypePage = 0, ArtifactType.e_ArtifactTypePagination = 1, ArtifactType.e_ArtifactTypeLayout = 2 }
	Enumeration for artifact type. More...

Public Member Functions
	TagTreeEditor (PDFDoc pdf_doc)
	Constructor. More...

	TagTreeEditor (TagTreeEditor other)
	Constructor, with another tag editor object. More...

TagTreeItemArray	AddNewTag (string selected_tag_id, string type, string title)
	Add a new tag to the tag tree. More...

TagTreeItemArray	AddTagForAnnotation (bool is_tag_annotations, Annot annot, int page_index, string selected_tag_id)
	Add tag for annotation. More...

bool	ChangeTagToArtifact (StringArray selected_tag_ids, TagTreeEditor.ArtifactType artifact_type, TagTreeEditor.ArtifactAttachToSideType artifact_to_side)
	Change tag to artifact. More...

TagTreeItemArray	CreateTagFromSelectionByContent (StringArray selected_content_ids, string selected_tag_id)
	Create tag from selection by content. More...

TagTreeItemArray	CreateTagFromSelectionByElement (int page_index, string selected_tag_id)
	Create tag from selection by element. More...

TagTreeItemArray	CreateTagFromSelectionByTag (StringArray selected_tag_ids, string last_selected_tag_id)
	Create tag from selection by tag. More...

TagTreeItemArray	CreateTagFromSelectionByText (int page_index, RectFArray selected_text_rects, string selected_tag_id)
	Create tag from selection by text. More...

TagTreeItemArray	DeleteEmptyTags (StringArray selected_tag_ids)
	Delete empty tags from the tag tree. More...

TagTreeItemArray	DeleteTags (StringArray selected_tag_ids)
	Delete specified tags from the tag tree. More...

StringArray	FindTagFromSelection (StringArray selected_tag_ids)
	Find tag from selection. More...

string	GetAllContents (string selected_tag_id)
	Get all contents of a specified tag item. More...

StringArray	GetContentTreeItemIDsByTagItemID (string selected_tag_id)
	Get content tree item IDs by tag item ID. More...

TagProperty	GetTagPropertyByID (string item_id)
	Get tag property by tag item ID. More...

TagTreeItemArray	GetTagTree ()
	Get the tag tree of the current PDF document. More...

TagTreeMenuItemDataArray	GetTagTreeContextMenuItems (TagTreeMenuInputData input_data)
	Get context menu items for tag tree. More...

bool	IsEmpty ()
	Check whether current object is empty or not. More...

TagTreeItemArray	MoveTags (StringArray source_tag_ids, string dest_tag_id, bool is_moved_as_child)
	Move tags in the tag tree. More...

bool	SetDocAsTaggedPDF ()
	Set the current PDF document as a tagged PDF. More...

bool	SetTagPropertyActualText (string item_id, string actual_text)
	Set tag property actual text for a specified tag item. More...

bool	SetTagPropertyAlternateText (string item_id, string alternate_text)
	Set tag property alternate text for a specified tag item. More...

bool	SetTagPropertyID (string item_id, string id)
	Set tag property ID for a specified tag item. More...

bool	SetTagPropertyLanguage (string item_id, string language)
	Set tag property language for a specified tag item. More...

bool	SetTagPropertyTitle (string item_id, string title)
	Set tag property title for a specified tag item. More...

bool	SetTagPropertyType (string item_id, string type)
	Set tag property type for a specified tag item. More...

Detailed Description

This class lets user edit the tag tree (structure tree) of a PDF document: query and modify tag properties, add / delete / move tags, create tags from selection, change tags to artifacts and mark the document as a tagged PDF. Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function common.Library.Initialize with a key including "Accessibility" module.

See also: foxit.common.Library

Member Enumeration Documentation

◆ ArtifactAttachToSideType

enum foxit.addon.accessibility.TagTreeEditor.ArtifactAttachToSideType

strong

Enumeration for artifact attach-to-side type.

Values of this enumeration should be used alone.

Enumerator
e_ArtifactAttachToSideTypeNone	Artifact attach side: none.
e_ArtifactAttachToSideTypeLeft	Artifact attach side: left.
e_ArtifactAttachToSideTypeTop	Artifact attach side: top.
e_ArtifactAttachToSideTypeRight	Artifact attach side: right.
e_ArtifactAttachToSideTypeBottom	Artifact attach side: bottom.

◆ ArtifactType

enum foxit.addon.accessibility.TagTreeEditor.ArtifactType

strong

Enumeration for artifact type.

Values of this enumeration should be used alone.

Enumerator
e_ArtifactTypePage	Artifact type: page-level artifact.
e_ArtifactTypePagination	Artifact type: pagination-related artifact (e.g., headers/footers).
e_ArtifactTypeLayout	Artifact type: layout artifact (visual layout elements).

Constructor & Destructor Documentation

◆ TagTreeEditor() [1/2]

foxit.addon.accessibility.TagTreeEditor.TagTreeEditor ( PDFDoc pdf_doc )

inline

Constructor.

Parameters

[in] pdf_doc A valid PDF document object.

◆ TagTreeEditor() [2/2]

foxit.addon.accessibility.TagTreeEditor.TagTreeEditor ( TagTreeEditor other )

inline

Constructor, with another tag editor object.

Parameters

[in] other Another tag editor object.

Member Function Documentation

◆ AddNewTag()

TagTreeItemArray foxit.addon.accessibility.TagTreeEditor.AddNewTag	(	string	selected_tag_id,
		string	type,
		string	title
	)

inline

Add a new tag to the tag tree.

Parameters

[in]	selected_tag_id	The selected tag ID as parent.
[in]	type	The tag type.
[in]	title	The tag title.

Returns: The updated tag tree item array.

◆ AddTagForAnnotation()

TagTreeItemArray foxit.addon.accessibility.TagTreeEditor.AddTagForAnnotation	(	bool	is_tag_annotations,
		Annot	annot,
		int	page_index,
		string	selected_tag_id
	)

inline

Add tag for annotation.

Parameters

[in]	is_tag_annotations	Whether to tag annotations.
[in]	annot	The annotation object.
[in]	page_index	The page index. Valid range: from 0 to (count-1), where count is returned by function pdf.PDFDoc.GetPageCount .
[in]	selected_tag_id	The selected tag ID.

Returns: The updated tag tree item array.

◆ ChangeTagToArtifact()

bool foxit.addon.accessibility.TagTreeEditor.ChangeTagToArtifact	(	StringArray	selected_tag_ids,
		TagTreeEditor.ArtifactType	artifact_type,
		TagTreeEditor.ArtifactAttachToSideType	artifact_to_side
	)

inline

Change tag to artifact.

Parameters

[in]	selected_tag_ids	The selected tag IDs.
[in]	artifact_type	The artifact type. Please refer to .
[in]	artifact_to_side	The artifact attach to side type. Please refer to .

Returns: true means success, while false means not.

◆ CreateTagFromSelectionByContent()

TagTreeItemArray foxit.addon.accessibility.TagTreeEditor.CreateTagFromSelectionByContent	(	StringArray	selected_content_ids,
		string	selected_tag_id
	)

inline

Create tag from selection by content.

Parameters

[in]	selected_content_ids	The selected content IDs.
[in]	selected_tag_id	The selected tag ID.

Returns: The updated tag tree item array.

◆ CreateTagFromSelectionByElement()

TagTreeItemArray foxit.addon.accessibility.TagTreeEditor.CreateTagFromSelectionByElement	(	int	page_index,
		string	selected_tag_id
	)

inline

Create tag from selection by element.

Parameters

[in]	page_index	The page index. Valid range: from 0 to (count-1), where count is returned by function pdf.PDFDoc.GetPageCount .
[in]	selected_tag_id	The selected tag ID.

Returns: The updated tag tree item array.

◆ CreateTagFromSelectionByTag()

TagTreeItemArray foxit.addon.accessibility.TagTreeEditor.CreateTagFromSelectionByTag	(	StringArray	selected_tag_ids,
		string	last_selected_tag_id
	)

inline

Create tag from selection by tag.

Parameters

[in]	selected_tag_ids	The selected tag IDs.
[in]	last_selected_tag_id	The last selected tag ID.

Returns: The updated tag tree item array.

◆ CreateTagFromSelectionByText()

TagTreeItemArray foxit.addon.accessibility.TagTreeEditor.CreateTagFromSelectionByText	(	int	page_index,
		RectFArray	selected_text_rects,
		string	selected_tag_id
	)

inline

Create tag from selection by text.

Parameters

[in]	page_index	The page index. Valid range: from 0 to (count-1), where count is returned by function pdf.PDFDoc.GetPageCount .
[in]	selected_text_rects	The selected text rectangles.
[in]	selected_tag_id	The selected tag ID.

Returns: The updated tag tree item array.

◆ DeleteEmptyTags()

TagTreeItemArray foxit.addon.accessibility.TagTreeEditor.DeleteEmptyTags ( StringArray selected_tag_ids )

inline

Delete empty tags from the tag tree.

Parameters

[in] selected_tag_ids The array of tag IDs to check for empty tags.

Returns: The updated tag tree item array.

◆ DeleteTags()

TagTreeItemArray foxit.addon.accessibility.TagTreeEditor.DeleteTags ( StringArray selected_tag_ids )

inline

Delete specified tags from the tag tree.

Parameters

[in] selected_tag_ids The array of tag IDs to delete.

Returns: The updated tag tree item array.

◆ FindTagFromSelection()

StringArray foxit.addon.accessibility.TagTreeEditor.FindTagFromSelection ( StringArray selected_tag_ids )

inline

Find tag from selection.

Parameters

[in] selected_tag_ids The selected tag IDs.

Returns: The array of found tag IDs.

◆ GetAllContents()

string foxit.addon.accessibility.TagTreeEditor.GetAllContents ( string selected_tag_id )

inline

Get all contents of a specified tag item.

Parameters

[in] selected_tag_id The selected tag ID.

Returns: The content text.

◆ GetContentTreeItemIDsByTagItemID()

StringArray foxit.addon.accessibility.TagTreeEditor.GetContentTreeItemIDsByTagItemID ( string selected_tag_id )

inline

Get content tree item IDs by tag item ID.

Parameters

[in] selected_tag_id The selected tag ID.

Returns: The array of content tree item IDs.

◆ GetTagPropertyByID()

TagProperty foxit.addon.accessibility.TagTreeEditor.GetTagPropertyByID ( string item_id )

inline

Get tag property by tag item ID.

Parameters

[in] item_id The tag item ID, obtained from TagTreeItemData::item_id of items returned by TagTreeEditor.GetTagTree .

Returns: The tag property object.

Note: The tag item referenced by item_id must be a structure element (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeElement ) node. Reference-type nodes such as marked content (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeMarkedContentSeq ) or object reference (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeObject ) do not carry this property and will cause the call to fail.

◆ GetTagTree()

TagTreeItemArray foxit.addon.accessibility.TagTreeEditor.GetTagTree ( )

inline

Get the tag tree of the current PDF document.

Returns: The tag tree item array.

◆ GetTagTreeContextMenuItems()

TagTreeMenuItemDataArray foxit.addon.accessibility.TagTreeEditor.GetTagTreeContextMenuItems ( TagTreeMenuInputData input_data )

inline

Get context menu items for tag tree.

Parameters

[in] input_data The input data for context menu.

Returns: The array of menu item data.

◆ IsEmpty()

bool foxit.addon.accessibility.TagTreeEditor.IsEmpty ( )

inline

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns: true means current object is empty, while false means not.

◆ MoveTags()

TagTreeItemArray foxit.addon.accessibility.TagTreeEditor.MoveTags	(	StringArray	source_tag_ids,
		string	dest_tag_id,
		bool	is_moved_as_child
	)

inline

Move tags in the tag tree.

Parameters

[in]	source_tag_ids	The source tag IDs to move.
[in]	dest_tag_id	The destination tag ID.
[in]	is_moved_as_child	Whether to move as child of destination.

Returns: The updated tag tree item array.

◆ SetDocAsTaggedPDF()

bool foxit.addon.accessibility.TagTreeEditor.SetDocAsTaggedPDF ( )

inline

Set the current PDF document as a tagged PDF.

Returns: true means success, while false means not.

◆ SetTagPropertyActualText()

bool foxit.addon.accessibility.TagTreeEditor.SetTagPropertyActualText	(	string	item_id,
		string	actual_text
	)

inline

Set tag property actual text for a specified tag item.

Parameters

[in]	item_id	The tag item ID, obtained from TagTreeItemData::item_id of items returned by TagTreeEditor.GetTagTree .
[in]	actual_text	The actual text to set.

Returns: true means success, while false means not.

Note: The tag item referenced by item_id must be a structure element (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeElement ) node. Reference-type nodes such as marked content (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeMarkedContentSeq ) or object reference (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeObject ) do not carry this property and will cause the call to fail.

◆ SetTagPropertyAlternateText()

bool foxit.addon.accessibility.TagTreeEditor.SetTagPropertyAlternateText	(	string	item_id,
		string	alternate_text
	)

inline

Set tag property alternate text for a specified tag item.

Parameters

[in]	item_id	The tag item ID, obtained from TagTreeItemData::item_id of items returned by TagTreeEditor.GetTagTree .
[in]	alternate_text	The alternate text to set.

Returns: true means success, while false means not.

Note: The tag item referenced by item_id must be a structure element (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeElement ) node. Reference-type nodes such as marked content (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeMarkedContentSeq ) or object reference (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeObject ) do not carry this property and will cause the call to fail.

◆ SetTagPropertyID()

bool foxit.addon.accessibility.TagTreeEditor.SetTagPropertyID	(	string	item_id,
		string	id
	)

inline

Set tag property ID for a specified tag item.

Parameters

[in]	item_id	The tag item ID, obtained from TagTreeItemData::item_id of items returned by TagTreeEditor.GetTagTree .
[in]	id	The ID to set.

Returns: true means success, while false means not.

Note: The tag item referenced by item_id must be a structure element (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeElement ) node. Reference-type nodes such as marked content (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeMarkedContentSeq ) or object reference (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeObject ) do not carry this property and will cause the call to fail.

◆ SetTagPropertyLanguage()

bool foxit.addon.accessibility.TagTreeEditor.SetTagPropertyLanguage	(	string	item_id,
		string	language
	)

inline

Set tag property language for a specified tag item.

Parameters

[in]	item_id	The tag item ID, obtained from TagTreeItemData::item_id of items returned by TagTreeEditor.GetTagTree .
[in]	language	The language to set.

Returns: true means success, while false means not.

Note: The tag item referenced by item_id must be a structure element (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeElement ) node. Reference-type nodes such as marked content (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeMarkedContentSeq ) or object reference (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeObject ) do not carry this property and will cause the call to fail.

◆ SetTagPropertyTitle()

bool foxit.addon.accessibility.TagTreeEditor.SetTagPropertyTitle	(	string	item_id,
		string	title
	)

inline

Set tag property title for a specified tag item.

Parameters

[in]	item_id	The tag item ID, obtained from TagTreeItemData::item_id of items returned by TagTreeEditor.GetTagTree .
[in]	title	The tag title to set.

Returns: true means success, while false means not.

Note: The tag item referenced by item_id must be a structure element (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeElement ) node. Reference-type nodes such as marked content (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeMarkedContentSeq ) or object reference (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeObject ) do not carry this property and will cause the call to fail.

◆ SetTagPropertyType()

bool foxit.addon.accessibility.TagTreeEditor.SetTagPropertyType	(	string	item_id,
		string	type
	)

inline

Set tag property type for a specified tag item.

Parameters

[in]	item_id	The tag item ID, obtained from TagTreeItemData::item_id of items returned by TagTreeEditor.GetTagTree .
[in]	type	The tag type to set.

Returns: true means success, while false means not.

Note: The tag item referenced by item_id must be a structure element (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeElement ) node. Reference-type nodes such as marked content (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeMarkedContentSeq ) or object reference (foxit.addon.accessibility.TagTreeItemData.TagNodeType.e_TagNodeTypeObject ) do not carry this property and will cause the call to fail.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ArtifactAttachToSideType

◆ ArtifactType

Constructor & Destructor Documentation

◆ TagTreeEditor() [1/2]

◆ TagTreeEditor() [2/2]

Member Function Documentation

◆ AddNewTag()

◆ AddTagForAnnotation()

◆ ChangeTagToArtifact()

◆ CreateTagFromSelectionByContent()

◆ CreateTagFromSelectionByElement()

◆ CreateTagFromSelectionByTag()

◆ CreateTagFromSelectionByText()

◆ DeleteEmptyTags()

◆ DeleteTags()

◆ FindTagFromSelection()

◆ GetAllContents()

◆ GetContentTreeItemIDsByTagItemID()

◆ GetTagPropertyByID()

◆ GetTagTree()

◆ GetTagTreeContextMenuItems()

◆ IsEmpty()

◆ MoveTags()

◆ SetDocAsTaggedPDF()

◆ SetTagPropertyActualText()

◆ SetTagPropertyAlternateText()

◆ SetTagPropertyID()

◆ SetTagPropertyLanguage()

◆ SetTagPropertyTitle()

◆ SetTagPropertyType()