Public 成员函数
	AddNewTag (selected_tag_id, type, title)
	向标签树添加一个新标签。更多...

	AddTagForAnnotation (is_tag_annotations, annot, page_index, selected_tag_id)
	为注释添加标签。更多...

	ChangeTagToArtifact (selected_tag_ids, artifact_type, artifact_to_side)
	将标签更改为装饰物。更多...

	constructor (pdf_doc)
	构造函数。更多...

	CreateTagFromSelectionByContent (selected_content_ids, selected_tag_id)
	按内容从选区创建标签。更多...

	CreateTagFromSelectionByElement (page_index, selected_tag_id)
	按元素从选区创建标签。更多...

	CreateTagFromSelectionByTag (selected_tag_ids, last_selected_tag_id)
	按标签从选区创建标签。更多...

	CreateTagFromSelectionByText (page_index, selected_text_rects, selected_tag_id)
	按文本从选区创建标签。更多...

	DeleteEmptyTags (selected_tag_ids)
	从标签树中删除空标签。更多...

	DeleteTags (selected_tag_ids)
	从标签树中删除指定的标签。更多...

	FindTagFromSelection (selected_tag_ids)
	从选区查找标签。更多...

	GetAllContents (selected_tag_id)
	获取指定标签项的所有内容。更多...

	GetContentTreeItemIDsByTagItemID (selected_tag_id)
	通过标签项 ID 获取内容树项 ID。更多...

	GetTagPropertyByID (item_id)
	通过标签项 ID 获取标签属性。更多...

	GetTagTree ()
	获取当前 PDF 文档的标签树。更多...

	GetTagTreeContextMenuItems (input_data)
	获取标签树的上下文菜单项。更多...

	IsEmpty ()
	检查当前对象是否为空。更多...

	MoveTags (source_tag_ids, dest_tag_id, is_moved_as_child)
	在标签树中移动标签。更多...

	SetDocAsTaggedPDF ()
	将当前 PDF 文档设置为标记 PDF。更多...

	SetTagPropertyActualText (item_id, actual_text)
	为指定的标签项设置标签属性实际文本。更多...

	SetTagPropertyAlternateText (item_id, alternate_text)
	为指定的标签项设置标签属性替换文本。更多...

	SetTagPropertyID (item_id, id)
	为指定的标签项设置标签属性 ID。更多...

	SetTagPropertyLanguage (item_id, language)
	为指定的标签项设置标签属性语言。更多...

	SetTagPropertyTitle (item_id, title)
	为指定的标签项设置标签属性标题。更多...

	SetTagPropertyType (item_id, type)
	为指定的标签项设置标签属性类型。更多...

静态 Public 属性
static	e_ArtifactAttachToSideTypeBottom
	装饰物贴边：下。

static	e_ArtifactAttachToSideTypeLeft
	装饰物贴边：左。

static	e_ArtifactAttachToSideTypeNone
	装饰物贴边类型枚举。更多...

static	e_ArtifactAttachToSideTypeRight
	装饰物贴边：右。

static	e_ArtifactAttachToSideTypeTop
	装饰物贴边：上。

static	e_ArtifactTypeLayout
	装饰物类型：布局装饰物（视觉布局元素）。

static	e_ArtifactTypePage
	装饰物类型枚举。更多...

static	e_ArtifactTypePagination
	装饰物类型：分页相关装饰物（例如页眉/页脚）。

详细描述

此类允许用户编辑 PDF 文档的标签树（结构树）：查询和修改标签属性、添加/删除/移动标签、从选区创建标签、将标签更改为装饰物，以及将文档标记为标记 PDF。在使用此模块中的任何类或方法之前，请确保 Foxit PDF SDK 已通过包含 "Accessibility"模块的密钥成功调用函数 FSDK.Library.Initialize 进行初始化。

参见: FSDK.Library

成员函数说明

◆ AddNewTag()

FSDK::TagTreeEditor::AddNewTag	(	selected_tag_id,
		type,
		title
	)

inline

向标签树添加一个新标签。

参数

[in]	selected_tag_id	作为父级的选中标签 ID。
[in]	type	标签类型。
[in]	title	标签标题。

返回: 更新后的标签树项数组。

◆ AddTagForAnnotation()

FSDK::TagTreeEditor::AddTagForAnnotation	(	is_tag_annotations,
		annot,
		page_index,
		selected_tag_id
	)

inline

为注释添加标签。

参数

[in]	is_tag_annotations	是否标记注释。
[in]	annot	注释对象。
[in]	page_index	页面索引。
[in]	selected_tag_id	选中的标签 ID。

返回: 更新后的标签树项数组。

◆ ChangeTagToArtifact()

FSDK::TagTreeEditor::ChangeTagToArtifact	(	selected_tag_ids,
		artifact_type,
		artifact_to_side
	)

inline

将标签更改为装饰物。

参数

[in]	selected_tag_ids	选中的标签 ID。
[in]	artifact_type	装饰物类型。请参考 FSDK.ArtifactType。
[in]	artifact_to_side	装饰物贴边类型。请参考 FSDK.ArtifactAttachToSideType。

返回: true 表示成功，false 表示不成功。

◆ constructor()

FSDK::TagTreeEditor::constructor ( pdf_doc )

inline

构造函数。

参数

[in] pdf_doc 一个有效的 PDF 文档对象。

◆ CreateTagFromSelectionByContent()

FSDK::TagTreeEditor::CreateTagFromSelectionByContent	(	selected_content_ids,
		selected_tag_id
	)

inline

按内容从选区创建标签。

参数

[in]	selected_content_ids	选中的内容 ID。
[in]	selected_tag_id	选中的标签 ID。

返回: 更新后的标签树项数组。

◆ CreateTagFromSelectionByElement()

FSDK::TagTreeEditor::CreateTagFromSelectionByElement	(	page_index,
		selected_tag_id
	)

inline

按元素从选区创建标签。

参数

[in]	page_index	页面索引。
[in]	selected_tag_id	选中的标签 ID。

返回: 更新后的标签树项数组。

◆ CreateTagFromSelectionByTag()

FSDK::TagTreeEditor::CreateTagFromSelectionByTag	(	selected_tag_ids,
		last_selected_tag_id
	)

inline

按标签从选区创建标签。

参数

[in]	selected_tag_ids	选中的标签 ID。
[in]	last_selected_tag_id	最后选中的标签 ID。

返回: 更新后的标签树项数组。

◆ CreateTagFromSelectionByText()

FSDK::TagTreeEditor::CreateTagFromSelectionByText	(	page_index,
		selected_text_rects,
		selected_tag_id
	)

inline

按文本从选区创建标签。

参数

[in]	page_index	页面索引。
[in]	selected_text_rects	选中的文本矩形。
[in]	selected_tag_id	选中的标签 ID。

返回: 更新后的标签树项数组。

◆ DeleteEmptyTags()

FSDK::TagTreeEditor::DeleteEmptyTags ( selected_tag_ids )

inline

从标签树中删除空标签。

参数

[in] selected_tag_ids 用于检查空标签的标签 ID 数组。

返回: 更新后的标签树项数组。

◆ DeleteTags()

FSDK::TagTreeEditor::DeleteTags ( selected_tag_ids )

inline

从标签树中删除指定的标签。

参数

[in] selected_tag_ids 要删除的标签 ID 数组。

返回: 更新后的标签树项数组。

◆ FindTagFromSelection()

FSDK::TagTreeEditor::FindTagFromSelection ( selected_tag_ids )

inline

从选区查找标签。

参数

[in] selected_tag_ids 选中的标签 ID。

返回: 找到的标签 ID 数组。

◆ GetAllContents()

FSDK::TagTreeEditor::GetAllContents ( selected_tag_id )

inline

获取指定标签项的所有内容。

参数

[in] selected_tag_id 选中的标签 ID。

返回: 内容文本。

◆ GetContentTreeItemIDsByTagItemID()

FSDK::TagTreeEditor::GetContentTreeItemIDsByTagItemID ( selected_tag_id )

inline

通过标签项 ID 获取内容树项 ID。

参数

[in] selected_tag_id 选中的标签 ID。

返回: 内容树项 ID 数组。

◆ GetTagPropertyByID()

FSDK::TagTreeEditor::GetTagPropertyByID ( item_id )

inline

通过标签项 ID 获取标签属性。

参数

[in] item_id 标签项 ID，从 FSDK.TagTreeEditor.GetTagTree 返回项的 FSDK.TagTreeItemData.item_id 获取。

返回: 标签属性对象。

注解: item_id 引用的标签项必须是结构元素（FSDK.TagTreeItemData.e_TagNodeTypeElement）节点。诸如标记内容（FSDK.TagTreeItemData.e_TagNodeTypeMarkedContentSeq）或对象引用（FSDK.TagTreeItemData.e_TagNodeTypeObject）之类的引用类型节点不携带此属性，会导致调用失败。

◆ GetTagTree()

FSDK::TagTreeEditor::GetTagTree ( )

inline

获取当前 PDF 文档的标签树。

返回: 标签树项数组。

◆ GetTagTreeContextMenuItems()

FSDK::TagTreeEditor::GetTagTreeContextMenuItems ( input_data )

inline

获取标签树的上下文菜单项。

参数

[in] input_data 上下文菜单的输入数据。

返回: 菜单项数据数组。

◆ IsEmpty()

FSDK::TagTreeEditor::IsEmpty ( )

inline

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

返回: true 表示当前对象为空，false 表示不为空。

◆ MoveTags()

FSDK::TagTreeEditor::MoveTags	(	source_tag_ids,
		dest_tag_id,
		is_moved_as_child
	)

inline

在标签树中移动标签。

参数

[in]	source_tag_ids	要移动的源标签 ID。
[in]	dest_tag_id	目标标签 ID。
[in]	is_moved_as_child	是否作为目标的子级移动。

返回: 更新后的标签树项数组。

◆ SetDocAsTaggedPDF()

FSDK::TagTreeEditor::SetDocAsTaggedPDF ( )

inline

将当前 PDF 文档设置为标记 PDF。

返回: true 表示成功，false 表示不成功。

◆ SetTagPropertyActualText()

FSDK::TagTreeEditor::SetTagPropertyActualText	(	item_id,
		actual_text
	)

inline

为指定的标签项设置标签属性实际文本。

参数

[in]	item_id	标签项 ID，从 FSDK.TagTreeEditor.GetTagTree 返回项的 FSDK.TagTreeItemData.item_id 获取。
[in]	actual_text	要设置的实际文本。

返回: true 表示成功，false 表示不成功。

注解: item_id 引用的标签项必须是结构元素（FSDK.TagTreeItemData.e_TagNodeTypeElement）节点。诸如标记内容（FSDK.TagTreeItemData.e_TagNodeTypeMarkedContentSeq）或对象引用（FSDK.TagTreeItemData.e_TagNodeTypeObject）之类的引用类型节点不携带此属性，会导致调用失败。

◆ SetTagPropertyAlternateText()

FSDK::TagTreeEditor::SetTagPropertyAlternateText	(	item_id,
		alternate_text
	)

inline

为指定的标签项设置标签属性替换文本。

参数

[in]	item_id	标签项 ID，从 FSDK.TagTreeEditor.GetTagTree 返回项的 FSDK.TagTreeItemData.item_id 获取。
[in]	alternate_text	要设置的替换文本。

返回: true 表示成功，false 表示不成功。

注解: item_id 引用的标签项必须是结构元素（FSDK.TagTreeItemData.e_TagNodeTypeElement）节点。诸如标记内容（FSDK.TagTreeItemData.e_TagNodeTypeMarkedContentSeq）或对象引用（FSDK.TagTreeItemData.e_TagNodeTypeObject）之类的引用类型节点不携带此属性，会导致调用失败。

◆ SetTagPropertyID()

FSDK::TagTreeEditor::SetTagPropertyID	(	item_id,
		id
	)

inline

为指定的标签项设置标签属性 ID。

参数

[in]	item_id	标签项 ID，从 FSDK.TagTreeEditor.GetTagTree 返回项的 FSDK.TagTreeItemData.item_id 获取。
[in]	id	要设置的 ID。

返回: true 表示成功，false 表示不成功。

注解: item_id 引用的标签项必须是结构元素（FSDK.TagTreeItemData.e_TagNodeTypeElement）节点。诸如标记内容（FSDK.TagTreeItemData.e_TagNodeTypeMarkedContentSeq）或对象引用（FSDK.TagTreeItemData.e_TagNodeTypeObject）之类的引用类型节点不携带此属性，会导致调用失败。

◆ SetTagPropertyLanguage()

FSDK::TagTreeEditor::SetTagPropertyLanguage	(	item_id,
		language
	)

inline

为指定的标签项设置标签属性语言。

参数

[in]	item_id	标签项 ID，从 FSDK.TagTreeEditor.GetTagTree 返回项的 FSDK.TagTreeItemData.item_id 获取。
[in]	language	要设置的语言。

返回: true 表示成功，false 表示不成功。

注解: item_id 引用的标签项必须是结构元素（FSDK.TagTreeItemData.e_TagNodeTypeElement）节点。诸如标记内容（FSDK.TagTreeItemData.e_TagNodeTypeMarkedContentSeq）或对象引用（FSDK.TagTreeItemData.e_TagNodeTypeObject）之类的引用类型节点不携带此属性，会导致调用失败。

◆ SetTagPropertyTitle()

FSDK::TagTreeEditor::SetTagPropertyTitle	(	item_id,
		title
	)

inline

为指定的标签项设置标签属性标题。

参数

[in]	item_id	标签项 ID，从 FSDK.TagTreeEditor.GetTagTree 返回项的 FSDK.TagTreeItemData.item_id 获取。
[in]	title	要设置的标签标题。

返回: true 表示成功，false 表示不成功。

注解: item_id 引用的标签项必须是结构元素（FSDK.TagTreeItemData.e_TagNodeTypeElement）节点。诸如标记内容（FSDK.TagTreeItemData.e_TagNodeTypeMarkedContentSeq）或对象引用（FSDK.TagTreeItemData.e_TagNodeTypeObject）之类的引用类型节点不携带此属性，会导致调用失败。

◆ SetTagPropertyType()

FSDK::TagTreeEditor::SetTagPropertyType	(	item_id,
		type
	)

inline

为指定的标签项设置标签属性类型。

参数

[in]	item_id	标签项 ID，从 FSDK.TagTreeEditor.GetTagTree 返回项的 FSDK.TagTreeItemData.item_id 获取。
[in]	type	要设置的标签类型。

返回: true 表示成功，false 表示不成功。

注解: item_id 引用的标签项必须是结构元素（FSDK.TagTreeItemData.e_TagNodeTypeElement）节点。诸如标记内容（FSDK.TagTreeItemData.e_TagNodeTypeMarkedContentSeq）或对象引用（FSDK.TagTreeItemData.e_TagNodeTypeObject）之类的引用类型节点不携带此属性，会导致调用失败。

类成员变量说明

◆ e_ArtifactAttachToSideTypeNone

FSDK::TagTreeEditor::e_ArtifactAttachToSideTypeNone

static

装饰物贴边类型枚举。

此枚举的值应单独使用。装饰物贴边：无。

◆ e_ArtifactTypePage

FSDK::TagTreeEditor::e_ArtifactTypePage

static

装饰物类型枚举。

此枚举的值应单独使用。装饰物类型：页面级装饰物。

Public 成员函数

静态 Public 属性

详细描述

成员函数说明

◆ AddNewTag()

◆ AddTagForAnnotation()

◆ ChangeTagToArtifact()

◆ constructor()

◆ CreateTagFromSelectionByContent()

◆ CreateTagFromSelectionByElement()

◆ CreateTagFromSelectionByTag()

◆ CreateTagFromSelectionByText()

◆ DeleteEmptyTags()

◆ DeleteTags()

◆ FindTagFromSelection()

◆ GetAllContents()

◆ GetContentTreeItemIDsByTagItemID()

◆ GetTagPropertyByID()

◆ GetTagTree()

◆ GetTagTreeContextMenuItems()

◆ IsEmpty()

◆ MoveTags()

◆ SetDocAsTaggedPDF()

◆ SetTagPropertyActualText()

◆ SetTagPropertyAlternateText()

◆ SetTagPropertyID()

◆ SetTagPropertyLanguage()

◆ SetTagPropertyTitle()

◆ SetTagPropertyType()

类成员变量说明

◆ e_ArtifactAttachToSideTypeNone

◆ e_ArtifactTypePage