类 foxit::pdf::annots::Annot 继承关系图:

Public 类型
enum	AppearanceType { e_AppearanceTypeNormal = 0, e_AppearanceTypeRollover = 1, e_AppearanceTypeDown = 2 }
	注释外观类型的枚举。更多...

enum	Flags { e_FlagInvisible = 0x0001, e_FlagHidden = 0x0002, e_FlagPrint = 0x0004, e_FlagNoZoom = 0x0008, e_FlagNoRotate = 0x0010, e_FlagNoView = 0x0020, e_FlagReadOnly = 0x0040, e_FlagLocked = 0x0080, e_FlagToggleNoView = 0x0100, e_FlagLockedContents = 0x0200 }
	PDF注释标志的枚举。更多...

enum	HighlightingMode { e_HighlightingNone = 0, e_HighlightingInvert = 1, e_HighlightingOutline = 2, e_HighlightingPush = 3, e_HighlightingToggle = 4 }
	PDF注释高亮模式的枚举。更多...

enum	MKEntry { e_MKEntryRotation = 0, e_MKEntryBorderColor = 1, e_MKEntryBackgroundColor = 2, e_MKEntryNormalCaption = 3, e_MKEntryRolloverCaption = 4, e_MKEntryDownCaption = 5, e_MKEntryNormalIcon = 6, e_MKEntryRolloverIcon = 7, e_MKEntryDownIcon = 8, e_MKEntryIconFit = 9, e_MKEntryIconCaptionRelation = 10 }
	注释MK字典（外观特征）条目的枚举。更多...

enum	MKIconCaptionRelation { e_MKRelationNoIcon = 0, e_MKRelationNoCaption = 1, e_MKRelationCaptionBelowIcon = 2, e_MKRelationCaptionAboveIcon = 3, e_MKRelationCaptionRight = 4, e_MKRelationCaptionLeft = 5, e_MKRelationCaptionOvrlayOnIcon = 6 }
	注释MK字典中图标和标题相对位置的枚举。更多...

enum	Property { e_PropertyModifiedDate = 0, e_PropertyCreationDate = 1, e_PropertyBorderColor = 2, e_PropertyFillColor = 3 }
	某些PDF注释属性的枚举。更多...

enum	Type { e_UnknownType = 0, e_Note = 1, e_Link = 2, e_FreeText = 3, e_Line = 4, e_Square = 5, e_Circle = 6, e_Polygon = 7, e_PolyLine = 8, e_Highlight = 9, e_Underline = 10, e_Squiggly = 11, e_StrikeOut = 12, e_Stamp = 13, e_Caret = 14, e_Ink = 15, e_PSInk = 16, e_FileAttachment = 17, e_Sound = 18, e_Movie = 19, e_Widget = 20, e_Screen = 21, e_PrinterMark = 22, e_TrapNet = 23, e_Watermark = 24, e_3D = 25, e_Popup = 26, e_Redact = 27, e_RichMedia = 28, e_PagingSeal = 29 }
	PDF注释类型的枚举。更多...

Public 成员函数
	Annot (const PDFPage &page, objects::PDFDictionary *annot_dict)
	构造函数，使用PDF页面和注释的PDF字典。更多...

	Annot (const Annot &annot)
	构造函数，使用另一个注释对象。更多...

	Annot ()
	构造函数。

virtual	~Annot ()
	析构函数。

objects::PDFStream *	GetAppearanceStream (AppearanceType type, const char *appearance_state="") const
	获取具有指定类型和状态的注释外观流。更多...

RGB	GetBorderColor () const
	获取边框颜色。更多...

BorderInfo	GetBorderInfo () const
	获取边框信息。更多...

WString	GetContent () const
	获取内容。更多...

RectI	GetDeviceRect (const Matrix &matrix)
	获取设备坐标系统中的注释矩形。更多...

objects::PDFDictionary *	GetDict () const
	获取注释的字典对象。更多...

Matrix	GetDisplayMatrix (const Matrix &page_display_matrix)
	获取显示矩阵，从PDF坐标系统到目标设备坐标系统。更多...

uint32	GetFlags () const
	获取注释标志。更多...

int	GetIndex () const
	获取当前注释在其所属页面中的索引。更多...

DateTime	GetModifiedDateTime () const
	获取最后修改日期时间。更多...

objects::PDFDictionary *	GetOptionalContent () const
	获取注释可选内容的PDF字典。更多...

PDFPage	GetPage () const
	获取相关的PDF页面。更多...

RectF	GetRect () const
	获取矩形，以PDF坐标系统表示。更多...

Type	GetType () const
	获取当前注释的实际注释类型。更多...

WString	GetUniqueID () const
	获取唯一ID。更多...

bool	HasProperty (Property property) const
	当前注释是否具有指定的注释属性。更多...

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

bool	IsMarkup () const
	检查当前注释是否为标记注释。更多...

bool	Move (const RectF &rect)
	将当前注释移动到新位置，由PDF坐标系统中的新矩形指定。更多...

bool	Move (const RectF &rect, bool is_reset_appearance)
	将当前注释移动到新位置，由PDF坐标系统中的新矩形指定。更多...

bool	operator != (const Annot &other) const
	不等于运算符。更多...

Annot &	operator= (const Annot &annot)
	赋值运算符。更多...

bool	operator== (const Annot &other) const
	等于运算符。更多...

bool	RemoveProperty (Property property)
	删除指定的注释属性。更多...

bool	ResetAppearanceStream ()
	重置外观流。更多...

bool	ResetAppearanceStream (bool is_generate_new_appearance_obj)
	重置外观流。更多...

void	SetBorderColor (RGB color)
	设置边框颜色。更多...

void	SetBorderInfo (const BorderInfo &border)
	设置边框信息。更多...

void	SetContent (const WString &content)
	设置内容。更多...

void	SetFlags (uint32 flags)
	设置注释标志。更多...

void	SetModifiedDateTime (const DateTime &date_time)
	设置最后修改日期时间。更多...

void	SetUniqueID (const WString &unique_id)
	设置唯一ID。更多...

Public 成员函数继承自 foxit::Base
FS_HANDLE	Handle () const
	获取当前对象的句柄。更多...

详细描述

注释将对象（如注记、声音或电影）与PDF文档页面上的位置关联起来，或提供通过鼠标和键盘与用户交互的方式。PDF包含各种各样的标准注释类型。
类Annot是所有PDF注释类型的基类。它提供获取/设置注释公共属性、移动注释或重置注释外观流的基础函数。对于具体的注释类型，请参考派生类。要获取注释计数或获取/添加/移除注释，请参考类pdfPDFPage。
此类对象也可用于构造其他类的对象，以便在注释中进行更多操作或访问注释的指定信息：

要访问附加动作，请使用注释对象构造actions::AdditionalAction对象。只有少数类型的注释可能有附加动作。有关更多详细信息，请参考类actions::AdditionalAction。
要在注释中搜索文本，请使用注释对象构造pdf::TextSearch对象。搜索只能支持某些类型的注释。有关更多详细信息，请参考类pdf::TextSearch。

注解

目前，以下类型的函数仅支持注记、高亮、下划线、删除线、波浪线、链接、矩形、圆形、自由文本、印章、插入符、墨迹、直线、多边形、折线、文件附件、弹出窗口、小组件、屏幕、PSInk、编辑注释：

类Annot中的所有"set"函数。
函数Annot::Move、Annot::ResetAppearanceStream、 Annot::RemoveProperty。

参见: pdf::PDFPage; actions::AdditionalAction; pdf::TextSearch

成员枚举类型说明

◆ AppearanceType

enum foxit::pdf::annots::Annot::AppearanceType

注释外观类型的枚举。

此枚举的值应单独使用。

枚举值
e_AppearanceTypeNormal	注释的正常外观。
e_AppearanceTypeRollover	注释的悬停外观。
e_AppearanceTypeDown	注释的按下外观。

◆ Flags

enum foxit::pdf::annots::Annot::Flags

PDF注释标志的枚举。

此枚举的值可以单独使用或组合使用。

枚举值
e_FlagInvisible	注释标志：不可见。如果设置，当注释不属于标准注释类型且没有可用的注释处理程序时，不显示该注释。如果清除，则使用其外观字典指定的外观流显示此类非标准注释（如果有）。
e_FlagHidden	注释标志：隐藏。如果设置，不显示或打印注释或允许用户与其交互，无论其注释类型如何或是否有可用的注释处理程序。
e_FlagPrint	注释标志：打印。如果设置，打印页面时打印注释。如果清除，从不打印注释，无论它是否显示在屏幕上。这可能很有用，例如，对于表示交互式按钮的注释，这些按钮在打印页面上没有意义。
e_FlagNoZoom	注释标志：无缩放。如果设置，不根据页面的放大倍数缩放注释的外观。注释在页面上的位置（由其注释矩形的左上角定义）保持固定，无论页面放大倍数如何。
e_FlagNoRotate	注释标志：无旋转。如果设置，不根据页面的旋转旋转注释的外观。注释矩形的左上角在页面上保持固定位置，无论页面旋转如何。
e_FlagNoView	注释标志：无视图。如果设置，不在屏幕上显示注释或允许用户与其交互。注释可能被打印（取决于标志Annot::e_FlagPrint的设置），但在屏幕显示和用户交互方面应被视为隐藏。
e_FlagReadOnly	注释标志：只读。如果设置，不允许注释与用户交互。注释可能显示或打印（取决于标志Annot::e_FlagNoView和Annot::e_FlagPrint的设置），但不应响应鼠标点击或响应鼠标移动而改变其外观。注解对于小组件注释，此标志被忽略；其功能被相关表单字段的标志 interform::Field::e_FlagReadOnly取代。
e_FlagLocked	注释标志：锁定。如果设置，不允许用户删除注释或修改其属性（包括位置和大小）。但是，此标志不限制对注释内容的更改，例如表单字段的值。
e_FlagToggleNoView	注释标志：切换无视图。如果设置，为某些事件反转NoView标志的解释。一个典型用途是使注释仅在鼠标光标悬停在其上时出现。
e_FlagLockedContents	注释标志：锁定内容。如果设置，不允许用户修改注释的内容。此标志不限制删除注释或更改其他注释属性，例如位置和大小。

◆ HighlightingMode

enum foxit::pdf::annots::Annot::HighlightingMode

PDF注释高亮模式的枚举。

此枚举的值应单独使用。

枚举值
e_HighlightingNone	高亮模式：无高亮。
e_HighlightingInvert	高亮模式：反转，即反转注释矩形的内容。
e_HighlightingOutline	高亮模式：轮廓，即反转注释的边框。
e_HighlightingPush	高亮模式：按下，即显示注释的按下外观（如果有）。
e_HighlightingToggle	高亮模式：切换。这仅对小组件注释有用。

◆ MKEntry

enum foxit::pdf::annots::Annot::MKEntry

注释MK字典（外观特征）条目的枚举。

此枚举的值应单独使用。

枚举值
e_MKEntryRotation	旋转条目。MK字典中的"R"。
e_MKEntryBorderColor	边框颜色条目。MK字典中的"BC"。
e_MKEntryBackgroundColor	背景颜色条目。MK字典中的"BG"。
e_MKEntryNormalCaption	正常标题条目。MK字典中的"CA"。注解仅适用于与按钮字段、复选框字段或单选按钮字段关联的小组件注释。
e_MKEntryRolloverCaption	悬停标题条目。MK字典中的"RC"。注解仅适用于与按钮字段关联的小组件注释。
e_MKEntryDownCaption	按下标题（或备用标题）条目。MK字典中的"AC"。注解仅适用于与按钮字段关联的小组件注释。
e_MKEntryNormalIcon	正常图标条目。MK字典中的"I"。注解仅适用于与按钮字段关联的小组件注释。
e_MKEntryRolloverIcon	悬停图标条目。MK字典中的"RI"。注解仅适用于与按钮字段关联的小组件注释。
e_MKEntryDownIcon	按下图标（或备用图标）条目。MK字典中的"IX"。注解仅适用于与按钮字段关联的小组件注释。
e_MKEntryIconFit	图标适配信息条目。MK字典中的"IF"。注解仅适用于与按钮字段关联的小组件注释。
e_MKEntryIconCaptionRelation	图标和标题关系条目。MK字典中的"TP"。注解仅适用于与按钮字段关联的小组件注释。用于指定小组件注释的mk标题文本相对于小组件注释的mk图标的位置。

◆ MKIconCaptionRelation

enum foxit::pdf::annots::Annot::MKIconCaptionRelation

注释MK字典中图标和标题相对位置的枚举。

此枚举的值应单独使用。

枚举值
e_MKRelationNoIcon	无图标；仅标题。
e_MKRelationNoCaption	无标题；仅图标。
e_MKRelationCaptionBelowIcon	标题在图标下方。
e_MKRelationCaptionAboveIcon	标题在图标上方。
e_MKRelationCaptionRight	标题在图标右侧。
e_MKRelationCaptionLeft	标题在图标左侧。
e_MKRelationCaptionOvrlayOnIcon	标题直接覆盖在图标上。

◆ Property

enum foxit::pdf::annots::Annot::Property

某些PDF注释属性的枚举。

此枚举的值应单独使用。

枚举值
e_PropertyModifiedDate	注释属性：修改日期。
e_PropertyCreationDate	注释属性：创建日期。只有标记注释可以具有创建日期属性。
e_PropertyBorderColor	注释属性：边框颜色。自由文本注释可以具有边框颜色属性，但不支持从自由文本注释中删除此属性。
e_PropertyFillColor	注释属性：填充颜色只有以下类型的注释可以具有填充颜色属性：正方形、圆形、自由文本、线条、多边形、折线、编辑。

◆ Type

enum foxit::pdf::annots::Annot::Type

PDF注释类型的枚举。

此枚举的值应单独使用。

枚举值
e_UnknownType	注释类型：未知。
e_Note	注释类型：注记注释，即"文本"注释 - <PDF参考1.7>中的标准注释之一。
e_Link	注释类型：链接注释。<PDF参考1.7>中的标准注释之一。
e_FreeText	注释类型：自由文本注释。<PDF参考1.7>中的标准注释之一。
e_Line	注释类型：直线注释。<PDF参考1.7>中的标准注释之一。
e_Square	注释类型：矩形注释。<PDF参考1.7>中的标准注释之一。
e_Circle	注释类型：圆形注释。<PDF参考1.7>中的标准注释之一。
e_Polygon	注释类型：多边形注释。<PDF参考1.7>中的标准注释之一。
e_PolyLine	注释类型：折线注释。<PDF参考1.7>中的标准注释之一。
e_Highlight	注释类型：高亮注释。<PDF参考1.7>中的标准注释之一。
e_Underline	注释类型：下划线注释。<PDF参考1.7>中的标准注释之一。
e_Squiggly	注释类型：波浪线注释。<PDF参考1.7>中的标准注释之一。
e_StrikeOut	注释类型：删除线注释。<PDF参考1.7>中的标准注释之一。
e_Stamp	注释类型：印章注释。<PDF参考1.7>中的标准注释之一。
e_Caret	注释类型：插入符注释。<PDF参考1.7>中的标准注释之一。
e_Ink	注释类型：墨迹注释。<PDF参考1.7>中的标准注释之一。
e_PSInk	注释类型：压力敏感墨迹注释。
e_FileAttachment	注释类型：文件附件注释。<PDF参考1.7>中的标准注释之一。
e_Sound	注释类型：声音注释。<PDF参考1.7>中的标准注释之一。
e_Movie	注释类型：电影注释。<PDF参考1.7>中的标准注释之一。
e_Widget	注释类型：小组件注释。<PDF参考1.7>中的标准注释之一。注解福昕PDF SDK将小组件注释视为表单控件。
e_Screen	注释类型：屏幕注释。<PDF参考1.7>中的标准注释之一。
e_PrinterMark	注释类型：印刷标记注释。<PDF参考1.7>中的标准注释之一。
e_TrapNet	注释类型：陷阱网络注释。<PDF参考1.7>中的标准注释之一。
e_Watermark	注释类型：水印注释。<PDF参考1.7>中的标准注释之一。
e_3D	注释类型：3D注释。<PDF参考1.7>中的标准注释之一。
e_Popup	注释类型：弹出注释。<PDF参考1.7>中的标准注释之一。
e_Redact	注释类型：编辑注释。
e_RichMedia	注释类型：富媒体注释。
e_PagingSeal	注释类型：分页印章注释。福昕PDF SDK自定义注释类型（非标准注释类型）。

构造及析构函数说明

◆ Annot() [1/2]

foxit::pdf::annots::Annot::Annot	(	const PDFPage &	page,
		objects::PDFDictionary *	annot_dict
	)

构造函数，使用PDF页面和注释的PDF字典。

参数

[in]	page	有效的PDF页面。
[in]	annot_dict	注释的PDF字典。它应该表示一个注释，并且应该在参数page指定的PDF页面中。

◆ Annot() [2/2]

foxit::pdf::annots::Annot::Annot ( const Annot & annot )

构造函数，使用另一个注释对象。

参数

[in] annot 另一个注释对象。

成员函数说明

◆ GetAppearanceStream()

objects::PDFStream* foxit::pdf::annots::Annot::GetAppearanceStream	(	AppearanceType	type,
		const char *	appearance_state = `""`
	)		const

获取具有指定类型和状态的注释外观流。

有关更多详细信息，请参考 <PDF参考1.7> 中 "表8.15 所有注释字典通用条目"中的"AP"和"AS"条目。

参数

[in]	type	注释外观类型。请参考 Annot::e_AppearanceTypeNormal 及相关值。
[in]	appearance_state	注释的外观状态，用于从外观子字典中选择适用的外观流。如果为空字符串，Foxit PDF SDK 将选择注释字典中"AS"（外观状态）条目指定的外观状态。

返回: 指定的注释外观流。如果没有与外观相关的条目或发生任何错误，此函数将返回 NULL。

◆ GetBorderColor()

RGB foxit::pdf::annots::Annot::GetBorderColor ( ) const

获取边框颜色。

此属性对注释的外观有影响。

返回: 边框颜色。格式：0xRRGGBB。如果找不到边框颜色，将返回0x000000。

◆ GetBorderInfo()

BorderInfo foxit::pdf::annots::Annot::GetBorderInfo ( ) const

获取边框信息。

此属性对注释的外观有影响。对于没有边框信息的注释，将返回默认边框信息：
边框宽度 = 1，边框样式 = BorderInfo::e_Solid，边框云状强度 = 0，边框虚线相位 = 0，边框虚线数组为空数组。注意：在支持的注释类型中（请参考类 Annot 的"注意"注释部分），此属性对以下注释的外观不起作用：注记、高亮、下划线、删除线、波浪线、印章、插入符、弹出窗口、文件附件、PSInk、编辑。对于墨迹注释，只有边框宽度对墨迹注释的外观有影响。

返回: 接收边框信息的边框信息对象。如果找不到任何边框信息，将返回"详细信息"部分所述的默认边框信息。

◆ GetContent()

WString foxit::pdf::annots::Annot::GetContent ( ) const

获取内容。

返回: 内容字符串。

◆ GetDeviceRect()

RectI foxit::pdf::annots::Annot::GetDeviceRect ( const Matrix & matrix )

获取设备坐标系统中的注释矩形。

这是获取注释的设备矩形的有用函数，但不支持弹出注释。
对于矩形转换，结果矩形始终是"标准化的"，即使用设备坐标系统：左侧始终小于右侧，顶部始终小于底部。

参数

[in] matrix 用于从PDF坐标系统转换到设备坐标系统的矩阵。通常，这由函数 pdf::PDFPage::GetDisplayMatrix返回，也用于渲染。

返回: 设备坐标系统中的注释矩形。如果没有矩形信息，将返回所有值为0的RectI对象。

◆ GetDict()

objects::PDFDictionary* foxit::pdf::annots::Annot::GetDict ( ) const

获取注释的字典对象。

返回: 注释的字典。如果有任何错误，此函数将返回NULL。

◆ GetDisplayMatrix()

Matrix foxit::pdf::annots::Annot::GetDisplayMatrix ( const Matrix & page_display_matrix )

获取显示矩阵，从PDF坐标系统到目标设备坐标系统。

当前注释的显示矩阵可以与注释的矩形一起使用，以计算注释在目标设备坐标系统中的实际区域。

参数

[in] page_display_matrix The transformation matrix. Usually this is returned by function PDFPage::GetDisplayMatrix.

返回: The display matrix of current annotation.

◆ GetFlags()

uint32 foxit::pdf::annots::Annot::GetFlags ( ) const

获取注释标志。

返回: 注释标志。请参考从Annot::e_FlagInvisible开始的值，这将是这些值中的一个或组合。0表示无注释标志。

◆ GetIndex()

int foxit::pdf::annots::Annot::GetIndex ( ) const

获取当前注释在其所属页面中的索引。

返回: 索引值，从0开始。

◆ GetModifiedDateTime()

DateTime foxit::pdf::annots::Annot::GetModifiedDateTime ( ) const

获取最后修改日期时间。

返回: 接收最后修改日期时间的日期和时间对象。如果没有修改日期时间信息，将返回所有值为0的日期和时间对象。

◆ GetOptionalContent()

objects::PDFDictionary* foxit::pdf::annots::Annot::GetOptionalContent ( ) const

获取注释可选内容的PDF字典。

返回: 注释可选内容的PDF字典。如果没有"OC"条目或发生任何错误，此函数将返回 NULL。

◆ GetPage()

PDFPage foxit::pdf::annots::Annot::GetPage ( ) const

获取相关的PDF页面。

返回: 作为相关PDF页面的PDF页面对象。

◆ GetRect()

RectF foxit::pdf::annots::Annot::GetRect ( ) const

获取矩形，以PDF坐标系统表示。

返回: 注释矩形。如果没有矩形信息，将返回所有值为0的RectF对象。

◆ GetType()

Type foxit::pdf::annots::Annot::GetType ( ) const

获取当前注释的实际注释类型。

返回: 注释类型。请参考从Annot::e_Note开始的值，这将是这些值中的一个。

◆ GetUniqueID()

WString foxit::pdf::annots::Annot::GetUniqueID ( ) const

获取唯一ID。

返回: 唯一ID字符串。

◆ HasProperty()

bool foxit::pdf::annots::Annot::HasProperty ( Property property ) const

当前注释是否具有指定的注释属性。

参数

[in] property 属性名称。请参考从Annot::e_PropertyModifiedDate开始的值，这应该是这些值中的一个。

返回: true表示当前注释具有指定的属性，而false表示当前注释没有指定的属性。

◆ IsEmpty()

bool foxit::pdf::annots::Annot::IsEmpty ( ) const

检查当前对象是否为空。

当当前对象为空时，这意味着当前对象是无用的。

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

◆ IsMarkup()

bool foxit::pdf::annots::Annot::IsMarkup ( ) const

检查当前注释是否为标记注释。

返回: true表示当前注释是标记注释，而false表示当前注释不是标记注释。

◆ Move() [1/2]

bool foxit::pdf::annots::Annot::Move ( const RectF & rect )

将当前注释移动到新位置，由PDF坐标系统中的新矩形指定。

参数

[in] rect 指定当前注释要移动到的新位置的新矩形。它应该在PDF坐标系统中有效。

返回: true表示成功，而false表示失败。

◆ Move() [2/2]

bool foxit::pdf::annots::Annot::Move	(	const RectF &	rect,
		bool	is_reset_appearance
	)

将当前注释移动到新位置，由PDF坐标系统中的新矩形指定。

参数

[in]	rect	指定当前注释要移动到的新位置的新矩形。它应该在PDF坐标系统中有效。
[in]	is_reset_appearance	布尔值，指定移动后是否重置注释的外观。

返回: true表示成功，而false表示失败。

◆ operator !=()

bool foxit::pdf::annots::Annot::operator != ( const Annot & other ) const

不等于运算符。

参数

[in] other 另一个注释对象。此函数将检查当前对象是否不等于此对象。

返回: true表示不相等，而false表示相等。

◆ operator=()

Annot& foxit::pdf::annots::Annot::operator= ( const Annot & annot )

赋值运算符。

参数

[in] annot 另一个注释对象，其值将赋值给当前对象。

返回: 对当前对象自身的引用。

◆ operator==()

bool foxit::pdf::annots::Annot::operator== ( const Annot & other ) const

等于运算符。

参数

[in] other 另一个注释对象。此函数将检查当前对象是否等于此对象。

返回: true表示相等，而false表示不相等。

◆ RemoveProperty()

bool foxit::pdf::annots::Annot::RemoveProperty ( Property property )

删除指定的注释属性。

此函数可用于删除注释的某些可选属性。当成功删除与外观相关的属性时，例如 Annot::e_PropertyBorderColor 和 Annot::e_PropertyFillColor，用户应调用函数 Annot::ResetAppearanceStream 以在注释外观上产生效果。

参数

[in] property 属性名称。请参考从 Annot::e_PropertyModifiedDate 开始的值，应为这些值中的一个。

返回: true 表示成功删除指定属性，或当前注释支持该属性但没有该属性。
false 表示当前注释不支持拥有指定属性，或当前注释无法删除指定属性。

◆ ResetAppearanceStream() [1/2]

bool foxit::pdf::annots::Annot::ResetAppearanceStream ( )

重置外观流。

注释的外观作为流存储在PDF文档中。任何与外观相关的属性都可以通过相应的设置函数进行更改。为了使此更改生效，应调用此函数来更新注释的外观。
请查看类 Annot 注释中的"注意"部分，了解哪些类型的注释可以通过当前函数重置外观，并检查这些注释类的注释，以了解在重置外观流之前是否需要任何属性。

返回: true 表示成功，false 表示失败。

◆ ResetAppearanceStream() [2/2]

bool foxit::pdf::annots::Annot::ResetAppearanceStream ( bool is_generate_new_appearance_obj )

重置外观流。

注释的外观作为流存储在PDF文档中。任何与外观相关的属性都可以通过相应的设置函数进行更改。为了使此更改生效，应调用此函数来更新注释的外观。
请查看类 Annot 注释中的"注意"部分，了解哪些类型的注释可以通过当前函数重置外观，并检查这些注释类的注释，以了解在重置外观流之前是否需要任何属性。

参数

[in] is_generate_new_appearance_obj true 表示生成新的外观对象来重置当前注释的外观， false 表示重置共享此外观流的注释的外观。该参数仅对小组件注释的外观有影响。

返回: true 表示成功，false 表示失败。

◆ SetBorderColor()

void foxit::pdf::annots::Annot::SetBorderColor ( RGB color )

设置边框颜色。

此属性对注释的外观有影响。如果用户希望新的边框颜色对注释的外观有影响，请在设置新边框颜色后调用函数Annot::ResetAppearanceStream。

参数

[in] color 要设置的新边框颜色。格式：0xRRGGBB。

返回: 无。

◆ SetBorderInfo()

void foxit::pdf::annots::Annot::SetBorderInfo ( const BorderInfo & border )

设置边框信息。

此属性对注释的外观有影响。如果用户希望新的边框信息对注释的外观有影响，请在设置新边框信息后调用函数 Annot::ResetAppearanceStream。
注意：在支持的注释类型中（请参考类 Annot 的"注意"注释部分），此属性对以下注释的外观不起作用：注记、高亮、下划线、删除线、波浪线、印章、插入符、弹出窗口、文件附件、PSInk、编辑。对于墨迹注释，只有边框宽度对墨迹注释的外观有影响。

参数

[in] border 要设置的新边框信息。应为有效的边框信息对象。如果参数 border 的任何值无效，此函数将无法为当前注释设置新边框信息。

返回: 无。

◆ SetContent()

void foxit::pdf::annots::Annot::SetContent ( const WString & content )

设置内容。

对于自由文本注释和直线注释（已启用标题），它们会在外观中显示内容。因此，对于这些类型的注释，此属性会影响注释的外观。如果用户希望效果显示在这些类型注释的外观中，请在设置新内容后调用函数Annot::ResetAppearanceStream。

参数

[in] content 要设置的新内容字符串。

返回: 无。

◆ SetFlags()

void foxit::pdf::annots::Annot::SetFlags ( uint32 flags )

设置注释标志。

参数

[in] flags 注释标志。可以是0，或者是从 Annot::e_FlagInvisible开始的值中的一个或组合。

返回: 无。

◆ SetModifiedDateTime()

void foxit::pdf::annots::Annot::SetModifiedDateTime ( const DateTime & date_time )

设置最后修改日期时间。

参数

[in] date_time 要设置的数据时间。它应该包含有效的日期时间数据。

返回: 无。

◆ SetUniqueID()

void foxit::pdf::annots::Annot::SetUniqueID ( const WString & unique_id )

设置唯一ID。

参数

[in] unique_id 要设置的新唯一ID字符串。

返回: 无。

Public 类型

Public 成员函数

详细描述

成员枚举类型说明

◆ AppearanceType

◆ Flags

◆ HighlightingMode

◆ MKEntry

◆ MKIconCaptionRelation

◆ Property

◆ Type

构造及析构函数说明

◆ Annot() [1/2]

◆ Annot() [2/2]

成员函数说明

◆ GetAppearanceStream()

◆ GetBorderColor()

◆ GetBorderInfo()

◆ GetContent()

◆ GetDeviceRect()

◆ GetDict()

◆ GetDisplayMatrix()

◆ GetFlags()

◆ GetIndex()

◆ GetModifiedDateTime()

◆ GetOptionalContent()

◆ GetPage()

◆ GetRect()

◆ GetType()

◆ GetUniqueID()

◆ HasProperty()

◆ IsEmpty()

◆ IsMarkup()

◆ Move() [1/2]

◆ Move() [2/2]

◆ operator !=()

◆ operator=()

◆ operator==()

◆ RemoveProperty()

◆ ResetAppearanceStream() [1/2]

◆ ResetAppearanceStream() [2/2]

◆ SetBorderColor()

◆ SetBorderInfo()

◆ SetContent()

◆ SetFlags()

◆ SetModifiedDateTime()

◆ SetUniqueID()