|
Foxit PDF SDK
|
Public 成员函数 | |
| constructor (page, annot_dict) | |
| 带有PDF页面和注释的PDF字典的构造函数。 更多... | |
| constructor () | |
| 构造函数。 | |
| GetAppearanceStream (type, appearance_state) | |
| 获取具有指定类型和状态的注释外观流。 更多... | |
| GetBorderColor () | |
| 获取边框颜色。 更多... | |
| GetBorderInfo () | |
| 获取边框信息。 更多... | |
| GetContent () | |
| 获取内容。 更多... | |
| GetDeviceRect (matrix) | |
| 获取设备坐标系中的注释矩形。 更多... | |
| GetDict () | |
| 获取注释的字典对象。 更多... | |
| GetDisplayMatrix (page_display_matrix) | |
| 获取从PDF坐标系到 目标设备坐标系的显示矩阵。 更多... | |
| GetFlags () | |
| 获取注释标志。 更多... | |
| GetIndex () | |
| 获取当前注释在其所属页面中的索引。 更多... | |
| GetModifiedDateTime () | |
| 获取上次修改日期时间。 更多... | |
| GetOptionalContent () | |
| 获取注释的可选内容的PDF字典。 更多... | |
| GetPage () | |
| 获取相关的PDF页面。 更多... | |
| GetRect () | |
| 获取PDF坐标系中的矩形。 更多... | |
| GetType () | |
| 获取当前注释的实际注释类型。 更多... | |
| GetUniqueID () | |
| 获取唯一ID。 更多... | |
| HasProperty (property) | |
| 当前注释是否具有指定的注释属性。 更多... | |
| IsEmpty () | |
| 检查当前对象是否为空。 更多... | |
| IsMarkup () | |
| 检查当前注释是否为标记注释。 更多... | |
| Move (rect) | |
| 将当前注释移动到新位置,由PDF坐标系中的新矩形指定。 更多... | |
| Move (rect, is_reset_appearance) | |
| 将当前注释移动到新位置,由PDF坐标系中的新矩形指定。 更多... | |
| RemoveProperty (property) | |
| 移除指定的注释属性。 更多... | |
| ResetAppearanceStream () | |
| 重置外观流。 更多... | |
| ResetAppearanceStream (is_generate_new_appearance_obj) | |
| 重置外观流。 更多... | |
| SetBorderColor (color) | |
| 设置边框颜色。 更多... | |
| SetBorderInfo (border) | |
| 设置边框信息。 更多... | |
| SetContent (content) | |
| 设置内容。 更多... | |
| SetFlags (flags) | |
| 设置注释标志。 更多... | |
| SetModifiedDateTime (date_time) | |
| 设置上次修改日期时间。 更多... | |
| SetUniqueID (unique_id) | |
| 设置唯一ID。 更多... | |
静态 Public 属性 | |
| static | e_3D |
| 注释类型:3D注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_AppearanceTypeDown |
| 注释的按下外观。 | |
| static | e_AppearanceTypeNormal |
| 注释外观类型的枚举。 更多... | |
| static | e_AppearanceTypeRollover |
| 注释的翻转外观。 | |
| static | e_Caret |
| 注释类型:插入符注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_Circle |
| 注释类型:圆形注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_FileAttachment |
| 注释类型:文件附件注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_FlagHidden |
| 注释标志:隐藏。 更多... | |
| static | e_FlagInvisible |
| PDF注释标志的枚举。 更多... | |
| static | e_FlagLocked |
| 注释标志:锁定。 更多... | |
| static | e_FlagLockedContents |
| 注释标志:锁定内容。 更多... | |
| static | e_FlagNoRotate |
| 注释标志:不旋转。 更多... | |
| static | e_FlagNoView |
| 注释标志:不查看。 更多... | |
| static | e_FlagNoZoom |
| 注释标志:不缩放。 更多... | |
| static | e_FlagPrint |
| 注释标志:打印。 更多... | |
| static | e_FlagReadOnly |
| 注释标志:只读。 更多... | |
| static | e_FlagToggleNoView |
| 注释标志:切换不查看。 更多... | |
| static | e_FreeText |
| 注释类型:自由文本注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_Highlight |
| 注释类型:高亮注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_HighlightingInvert |
| 高亮模式:反转,即反转注释矩形的内容。 | |
| static | e_HighlightingNone |
| PDF注释高亮模式的枚举。 更多... | |
| static | e_HighlightingOutline |
| 高亮模式:轮廓,即反转注释的边框。 | |
| static | e_HighlightingPush |
| 高亮模式:按下,即显示注释的按下外观(如果有)。 | |
| static | e_HighlightingToggle |
| 高亮模式:切换。这仅对小部件注释有用。 | |
| static | e_Ink |
| 注释类型:墨迹注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_Line |
| 注释类型:直线注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_Link |
| 注释类型:链接注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_MKEntryBackgroundColor |
| 背景颜色条目。MK字典中的"BG"。 | |
| static | e_MKEntryBorderColor |
| 边框颜色条目。MK字典中的"BC"。 | |
| static | e_MKEntryDownCaption |
| 按下标题(或替代标题)条目。MK字典中的"AC"。 更多... | |
| static | e_MKEntryDownIcon |
| 按下图标(或替代图标)条目。MK字典中的"IX"。 更多... | |
| static | e_MKEntryIconCaptionRelation |
| 图标和标题关系条目。MK字典中的"TP"。 更多... | |
| static | e_MKEntryIconFit |
| 图标适配信息条目。MK字典中的"IF"。 更多... | |
| static | e_MKEntryNormalCaption |
| 正常标题条目。MK字典中的"CA"。 更多... | |
| static | e_MKEntryNormalIcon |
| 正常图标条目。MK字典中的"I"。 更多... | |
| static | e_MKEntryRolloverCaption |
| 翻转标题条目。MK字典中的"RC"。 更多... | |
| static | e_MKEntryRolloverIcon |
| 翻转图标条目。MK字典中的"RI"。 更多... | |
| static | e_MKEntryRotation |
| 注释的MK字典(外观特性)条目的枚举。 更多... | |
| static | e_MKRelationCaptionAboveIcon |
| 标题在图标上方。 | |
| static | e_MKRelationCaptionBelowIcon |
| 标题在图标下方。 | |
| static | e_MKRelationCaptionLeft |
| 标题在图标左侧。 | |
| static | e_MKRelationCaptionOvrlayOnIcon |
| 标题直接覆盖在图标上。 | |
| static | e_MKRelationCaptionRight |
| 标题在图标右侧。 | |
| static | e_MKRelationNoCaption |
| 无标题;仅图标。 | |
| static | e_MKRelationNoIcon |
| 注释的MK字典中图标和标题相对位置的枚举。 更多... | |
| static | e_Movie |
| 注释类型:电影注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_Note |
| 注释类型:注释注释,即“文本”注释 - <PDF reference 1.7>中的标准注释之一。 | |
| static | e_PagingSeal |
| 注释类型:分页印章注释。Foxit PDF SDK自定义注释类型(非标准注释类型)。 | |
| static | e_Polygon |
| 注释类型:多边形注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_PolyLine |
| 注释类型:折线注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_Popup |
| 注释类型:弹出注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_PrinterMark |
| 注释类型:印刷商标记注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_PropertyBorderColor |
| 注释属性:边框颜色。 更多... | |
| static | e_PropertyCreationDate |
| 注释属性:创建日期。 更多... | |
| static | e_PropertyFillColor |
| 注释属性:填充颜色 更多... | |
| static | e_PropertyModifiedDate |
| 某些PDF注释属性的枚举。 更多... | |
| static | e_PSInk |
| 注释类型:压感墨迹注释。 | |
| static | e_Redact |
| 注释类型:涂黑注释。 | |
| static | e_RichMedia |
| 注释类型:富媒体注释。 | |
| static | e_Screen |
| 注释类型:屏幕注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_Sound |
| 注释类型:声音注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_Square |
| 注释类型:正方形注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_Squiggly |
| 注释类型:波浪线注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_Stamp |
| 注释类型:图章注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_StrikeOut |
| 注释类型:删除线注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_TrapNet |
| 注释类型:陷阱网络注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_Underline |
| 注释类型:下划线注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_UnknownType |
| PDF注释类型的枚举。 更多... | |
| static | e_Watermark |
| 注释类型:水印注释。<PDF reference 1.7>中的标准注释之一。 | |
| static | e_Widget |
| 注释类型:小部件注释。<PDF reference 1.7>中的标准注释之一。 更多... | |
注释将对象(如注释、声音或电影)与PDF文档页面上的位置关联,或提供通过鼠标和键盘与用户交互的方式。 PDF包括各种标准注释类型。
类 FSDK.Annot 是所有PDF注释的基类。它提供获取/设置注释公共属性、移动注释或重置注释外观流的基本功能。 对于具体的注释类型,请参阅派生类。要获取注释数量或获取/添加/删除注释,请参阅类FSDK.PDFPage。
此类对象也可用于构造其他类的对象,以便在注释中执行更多操作或访问注释的特定信息:
| FSDK::Annot::constructor | ( | page | , |
| annot_dict | |||
| ) |
带有PDF页面和注释的PDF字典的构造函数。
| [in] | page | 有效的PDF页面。 |
| [in] | annot_dict | 注释的PDF字典。它应该表示一个注释,并且应该在 参数page指定的PDF页面中。 |
| FSDK::Annot::GetAppearanceStream | ( | type | , |
| appearance_state | |||
| ) |
获取具有指定类型和状态的注释外观流。
有关更多详细信息,请参阅<PDF reference 1.7>中 "TABLE 8.15 Entries common to all annotation dictionaries"中的"AP"和"AS"条目。
| [in] | type | 注释外观的类型。请参阅从 FSDK.Annot.e_AppearanceTypeNormal 开始的值,这应该是这些值之一。 |
| [in] | appearance_state | 注释的外观状态,用于从外观子字典中选择 适用的外观流。 如果这是空字符串,Foxit PDF SDK将选择由注释字典中 "AS"(Appearance State)条目指定的外观状态。 |
| FSDK::Annot::GetBorderColor | ( | ) |
获取边框颜色。
此属性对注释的外观有影响。
| FSDK::Annot::GetBorderInfo | ( | ) |
获取边框信息。
此属性对注释的外观有影响。对于没有边框信息的注释, 将返回默认边框信息:
边框宽度 = 1,边框样式 = FSDK.BorderInfo.e_Solid, 边框云形强度 = 0,边框虚线相位 = 0,边框虚线数组为空数组。 注意:在支持的注释类型中(请参阅类 FSDK.Annot 的"Note"注释部分), 此属性对以下注释的外观不会产生影响: 注释、高亮、下划线、删除线、波浪线、图章、插入符、弹出、文件附件、PSInk、涂黑。 对于墨迹注释,只有边框宽度会对墨迹注释的外观产生影响。
| FSDK::Annot::GetContent | ( | ) |
获取内容。
| FSDK::Annot::GetDeviceRect | ( | matrix | ) |
获取设备坐标系中的注释矩形。
这是一个获取注释设备矩形的有用函数, 但不支持弹出注释。
对于矩形转换,结果矩形总是"归一化"的,即 使用设备坐标系:left总是小于right,top总是小于bottom。
| [in] | matrix | 用于从PDF坐标系转换到 设备坐标系的矩阵。通常,这是由函数 FSDK.PDFPage.GetDisplayMatrix 返回的,也用于渲染。 |
| FSDK::Annot::GetDict | ( | ) |
获取注释的字典对象。
| FSDK::Annot::GetDisplayMatrix | ( | page_display_matrix | ) |
获取从PDF坐标系到 目标设备坐标系的显示矩阵。
当前注释的显示矩阵可以与注释的矩形一起使用来 计算目标设备坐标系中注释的实际区域。
| [in] | page_display_matrix | 转换矩阵。通常这是由函数 FSDK.PDFPage.GetDisplayMatrix 返回的。 |
| FSDK::Annot::GetFlags | ( | ) |
获取注释标志。
| FSDK::Annot::GetIndex | ( | ) |
获取当前注释在其所属页面中的索引。
| FSDK::Annot::GetModifiedDateTime | ( | ) |
获取上次修改日期时间。
| FSDK::Annot::GetOptionalContent | ( | ) |
获取注释的可选内容的PDF字典。
| FSDK::Annot::GetPage | ( | ) |
获取相关的PDF页面。
| FSDK::Annot::GetRect | ( | ) |
获取PDF坐标系中的矩形。
| FSDK::Annot::GetType | ( | ) |
获取当前注释的实际注释类型。
| FSDK::Annot::GetUniqueID | ( | ) |
获取唯一ID。
| FSDK::Annot::HasProperty | ( | property | ) |
当前注释是否具有指定的注释属性。
| [in] | property | 属性名称。请参阅从 FSDK.Annot.e_PropertyModifiedDate 开始的值, 这应该是这些值之一。 |
| FSDK::Annot::IsEmpty | ( | ) |
检查当前对象是否为空。
当当前对象为空时,意味着当前对象是无用的。
| FSDK::Annot::IsMarkup | ( | ) |
检查当前注释是否为标记注释。
| FSDK::Annot::Move | ( | rect | ) |
| FSDK::Annot::Move | ( | rect | , |
| is_reset_appearance | |||
| ) |
| FSDK::Annot::RemoveProperty | ( | property | ) |
移除指定的注释属性。
此函数可用于移除注释的某些可选属性。 当成功移除与外观相关的属性时,例如 FSDK.Annot.e_PropertyBorderColor 和 FSDK.Annot.e_PropertyFillColor, 用户应调用函数 FSDK.Annot.ResetAppearanceStream 以对 注释的外观产生影响。
| [in] | property | 属性名称。请参阅从 FSDK.Annot.e_PropertyModifiedDate 开始的值, 这应该是这些值之一。 |
| FSDK::Annot::ResetAppearanceStream | ( | ) |
重置外观流。
注释的外观存储为PDF文档中的流。 任何与外观相关的属性都可以通过相应的设置函数进行更改。 要使此更改生效,应调用此函数来更新注释的外观。
请检查类 FSDK.Annot 注释中的"Note"部分,以查看当前函数可以 重置哪些类型的注释外观,并检查这些注释类中的注释,以查看 在重置外观流之前是否需要任何属性。
| FSDK::Annot::ResetAppearanceStream | ( | is_generate_new_appearance_obj | ) |
重置外观流。
注释的外观存储为PDF文档中的流。 任何与外观相关的属性都可以通过相应的设置函数进行更改。 要使此更改生效,应调用此函数来更新注释的外观。
请检查类 FSDK.Annot 注释中的"Note"部分,以查看当前函数可以 重置哪些类型的注释外观,并检查这些注释类中的注释,以查看 在重置外观流之前是否需要任何属性。
| [in] | is_generate_new_appearance_obj | true表示生成新的外观对象来重置 当前注释的外观,而false表示重置 共享此外观流的注释的外观。此 参数仅对小部件注释的外观有影响。 |
| FSDK::Annot::SetBorderColor | ( | color | ) |
设置边框颜色。
此属性对注释的外观有影响。如果用户希望新边框颜色对 注释的外观产生影响,请在设置新边框颜色后调用函数 FSDK.Annot.ResetAppearanceStream。
| [in] | color | 要设置的新边框颜色。格式:0xRRGGBB。 |
| FSDK::Annot::SetBorderInfo | ( | border | ) |
设置边框信息。
此属性对注释的外观有影响。如果用户希望新边框信息对 注释的外观产生影响,请在设置新边框信息后调用函数 FSDK.Annot.ResetAppearanceStream。
注意:在支持的注释类型中(请参阅类 FSDK.Annot 的"Note"注释部分), 此属性对以下注释的外观不会产生影响: 注释、高亮、下划线、删除线、波浪线、图章、插入符、弹出、文件附件、PSInk、涂黑。 对于墨迹注释,只有边框宽度会对墨迹注释的外观产生影响。
| [in] | border | 要设置的新边框信息。它应该是一个有效的边框信息对象。 如果参数border的任何值无效,此函数将无法将新边框 信息设置为当前注释。 |
| FSDK::Annot::SetContent | ( | content | ) |
设置内容。
对于自由文本注释和直线注释(已启用标题), 它们会在外观中显示内容。因此对于这些类型的注释,此属性会 对注释的外观产生影响。如果用户希望该效果在这些类型注释的外观中显示, 请在设置新内容后调用函数 FSDK.Annot.ResetAppearanceStream。
| [in] | content | 要设置的新内容字符串。 |
| FSDK::Annot::SetFlags | ( | flags | ) |
| FSDK::Annot::SetModifiedDateTime | ( | date_time | ) |
设置上次修改日期时间。
| [in] | date_time | 要设置的日期时间。它应包含有效的日期时间数据。 |
| FSDK::Annot::SetUniqueID | ( | unique_id | ) |
设置唯一ID。
| [in] | unique_id | 要设置的新唯一ID字符串。 |
|
static |
注释外观类型的枚举。
此枚举的值应单独使用。注释的正常外观。
|
static |
注释标志:隐藏。
如果设置,不显示或打印注释,也不允许它与用户交互, 无论其注释类型或是否有可用的注释处理程序。
|
static |
PDF注释标志的枚举。
此枚举的值可以单独使用或组合使用。注释标志:不可见。
如果设置,当注释不属于标准注释类型之一且没有可用的注释处理程序时,不显示注释。 如果清除,则使用其外观字典指定的外观流显示这种非标准注释(如果有)。
|
static |
注释标志:锁定。
如果设置,不允许用户删除注释或修改其属性(包括位置和大小)。 但是,此标志不限制对注释内容的更改,例如表单域的值。
|
static |
注释标志:锁定内容。
如果设置,不允许用户修改注释的内容。 此标志不限制删除注释或更改其他注释属性,例如位置和大小。
|
static |
注释标志:不旋转。
如果设置,不旋转注释的外观以匹配页面的旋转。 注释矩形的左上角在页面上保持固定位置, 无论页面旋转如何。
|
static |
注释标志:不查看。
如果设置,不在屏幕上显示注释,也不允许它与用户交互。 注释可以被打印(取决于标志 FSDK.Annot.e_FlagPrint 的设置), 但在屏幕显示和用户交互方面应被视为隐藏。
|
static |
注释标志:不缩放。
如果设置,不缩放注释的外观以匹配页面的放大倍率。 注释在页面上的位置(由其注释矩形的左上角定义)保持固定, 无论页面放大倍率如何。
|
static |
注释标志:打印。
如果设置,在打印页面时打印注释。如果清除,永远不打印注释, 无论它是否显示在屏幕上。例如,这对于表示交互式按钮的注释很有用, 因为它们在打印页上没有任何有意义的目的。
|
static |
注释标志:只读。
如果设置,不允许注释与用户交互。注释可以显示或打印 (取决于标志 FSDK.Annot.e_FlagNoView 和 FSDK.Annot.e_FlagPrint 的设置), 但不应响应鼠标单击或随鼠标移动而改变外观。
|
static |
注释标志:切换不查看。
如果设置,对于某些事件反转解释NoView标志。典型用法是 使注释仅在鼠标光标悬停在其上时显示。
|
static |
PDF注释高亮模式的枚举。
此枚举的值应单独使用。高亮模式:无高亮。
|
static |
按下标题(或替代标题)条目。MK字典中的"AC"。
|
static |
按下图标(或替代图标)条目。MK字典中的"IX"。
|
static |
图标和标题关系条目。MK字典中的"TP"。
|
static |
图标适配信息条目。MK字典中的"IF"。
|
static |
正常标题条目。MK字典中的"CA"。
|
static |
正常图标条目。MK字典中的"I"。
|
static |
翻转标题条目。MK字典中的"RC"。
|
static |
翻转图标条目。MK字典中的"RI"。
|
static |
注释的MK字典(外观特性)条目的枚举。
此枚举的值应单独使用。旋转条目。MK字典中的"R"。
|
static |
注释的MK字典中图标和标题相对位置的枚举。
此枚举的值应单独使用。无图标;仅标题。
|
static |
注释属性:边框颜色。
自由文本注释可以具有边框颜色属性,但 不支持从自由文本注释中移除此属性。
|
static |
注释属性:创建日期。
仅标记注释可以具有创建日期属性。
|
static |
注释属性:填充颜色
仅以下类型的注释可以具有填充颜色属性:
正方形、圆形、自由文本、直线、多边形、折线、涂黑。
|
static |
某些PDF注释属性的枚举。
此枚举的值应单独使用。注释属性:修改日期。
|
static |
PDF注释类型的枚举。
此枚举的值应单独使用。注释类型:未知。
|
static |
注释类型:小部件注释。<PDF reference 1.7>中的标准注释之一。