foxit.pdf.annots.Caret类 参考
类 foxit.pdf.annots.Caret 继承关系图:
Public 成员函数 | |
| Caret () | |
| 构造函数。 | |
| Caret (Annot annot) | |
| 构造函数，使用父类对象。 更多... | |
| RectF | GetInnerRect () |
| 获取内矩形。 更多... | |
| void | SetInnerRect (RectF inner_rect) |
| 设置内矩形。 更多... | |
 Public 成员函数 继承自 foxit.pdf.annots.Markup | |
| Markup (Annot annot) | |
| 构造函数，使用父类对象。 更多... | |
| Markup () | |
| 构造函数 | |
| Note | AddReply () |
| 在回复列表的末尾添加新回复。 更多... | |
| void | AddRichText (string content, RichTextStyle style) |
| 在末尾添加新的富文本字符串。 更多... | |
| Note | AddStateAnnot (string title, Markup.StateModel model, Markup.State state) |
| 添加新的状态注释。 更多... | |
| float | GetBorderOpacity () |
| 获取注释的边框透明度。 更多... | |
| DateTime | GetCreationDateTime () |
| 获取创建日期时间。 更多... | |
| float | GetFillOpacity () |
| 获取注释的填充透明度。 更多... | |
| MarkupArray | GetGroupElements () |
| 从当前标记注释所属的组中获取一个元素（作为标记注释）。 更多... | |
| Markup | GetGroupHeader () |
| 获取当前标记注释所属组的头注释（作为主注释）。 更多... | |
| string | GetIntent () |
| 获取意图名称。 更多... | |
| float | GetOpacity () |
| 获取不透明度值。 更多... | |
| Popup | GetPopup () |
| 获取相关的弹出注释。 更多... | |
| Note | GetReply (int index) |
| 按索引获取回复。 更多... | |
| int | GetReplyCount () |
| 计算所有回复。 更多... | |
| string | GetRichTextContent (int index) |
| 获取指定索引的富文本字符串的文本字符串。 更多... | |
| int | GetRichTextCount () |
| 获取富文本字符串的数量。 更多... | |
| RichTextStyle | GetRichTextStyle (int index) |
| 获取指定索引的富文本字符串的样式数据。 更多... | |
| NoteArray | GetStateAnnots (Markup.StateModel model) |
| 获取指定状态模型中的所有状态注释。 更多... | |
| string | GetSubject () |
| 获取主题字符串。 更多... | |
| string | GetTitle () |
| 获取标题字符串。 更多... | |
| void | InsertRichText (int index, string content, RichTextStyle style) |
| 在指定索引位置插入新的富文本字符串。 更多... | |
| bool | IsGrouped () |
| 检查当前标记注释是否在组中。 更多... | |
| bool | RemoveAllReplies () |
| 删除所有回复。 更多... | |
| bool | RemoveAllStateAnnots () |
| 移除所有状态注释。 更多... | |
| bool | RemovePopup () |
| 删除相关的弹出注释。 更多... | |
| bool | RemoveReply (int index) |
| 按索引删除回复。 更多... | |
| void | RemoveRichText (int index) |
| 移除指定索引的富文本字符串。 更多... | |
| void | SetBorderOpacity (float opacity) |
| 设置注释的边框透明度。 更多... | |
| void | SetCreationDateTime (DateTime date_time) |
| 设置创建日期时间。 更多... | |
| void | SetFillOpacity (float opacity) |
| 设置注释的填充透明度。 更多... | |
| void | SetIntent (string intent) |
| 设置意图名称。 更多... | |
| void | SetOpacity (float opacity) |
| 设置不透明度值。 更多... | |
| void | SetPopup (Popup popup) |
| 设置相关的弹出注释。 更多... | |
| void | SetRichTextContent (int index, string content) |
| 设置指定索引的富文本字符串的文本字符串。 更多... | |
| void | SetRichTextStyle (int index, RichTextStyle style) |
| 设置指定索引的富文本字符串的样式数据。 更多... | |
| void | SetSubject (string subject) |
| 设置主题字符串。 更多... | |
| void | SetTitle (string title) |
| 设置标题字符串。 更多... | |
| bool | Ungroup () |
| 将当前标记注释从其所属的组中解组。 更多... | |
| Public 成员函数 继承自 foxit.pdf.annots.Annot | |
| Annot (PDFPage page, PDFDictionary annot_dict) | |
| 构造函数，使用PDF页面和注释的PDF字典。 更多... | |
| Annot (Annot annot) | |
| 构造函数，使用另一个注释对象。 更多... | |
| Annot () | |
| 构造函数。 | |
| PDFStream | GetAppearanceStream (Annot.AppearanceType type, string appearance_state) |
| 获取具有指定类型和状态的注释外观流。 更多... | |
| int | GetBorderColor () |
| 获取边框颜色。 更多... | |
| BorderInfo | GetBorderInfo () |
| 获取边框信息。 更多... | |
| string | GetContent () |
| 获取内容。 更多... | |
| RectI | GetDeviceRect (Matrix2D matrix) |
| 获取设备坐标系统中的注释矩形。 更多... | |
| PDFDictionary | GetDict () |
| 获取注释的字典对象。 更多... | |
| Matrix2D | GetDisplayMatrix (Matrix2D page_display_matrix) |
| 获取显示矩阵，从到 目标设备坐标系统。 更多... | |
| int | GetFlags () |
| 获取注释标志。 更多... | |
| int | GetIndex () |
| 获取当前注释在其所属页面中的索引。 更多... | |
| DateTime | GetModifiedDateTime () |
| 获取最后修改日期时间。 更多... | |
| PDFDictionary | GetOptionalContent () |
| 获取注释可选内容的PDF字典。 更多... | |
| PDFPage | GetPage () |
| 获取相关的PDF页面。 更多... | |
| RectF | GetRect () |
| 获取矩形，以表示。 更多... | |
| Annot.Type | GetType () |
| 获取当前注释的实际注释类型。 更多... | |
| string | GetUniqueID () |
| 获取唯一ID。 更多... | |
| bool | HasProperty (Annot.Property property) |
| 当前注释是否具有指定的注释属性。 更多... | |
| bool | IsEmpty () |
| 检查当前对象是否为空。 更多... | |
| bool | IsMarkup () |
| 检查当前注释是否为标记注释。 更多... | |
| bool | Move (RectF rect) |
| 将当前注释移动到新位置，由中的新矩形指定。 更多... | |
| bool | Move (RectF rect, bool is_reset_appearance) |
| 将当前注释移动到新位置，由中的新矩形指定。 更多... | |
| bool | RemoveProperty (Annot.Property property) |
| 删除指定的注释属性。 更多... | |
| bool | ResetAppearanceStream () |
| 重置外观流。 更多... | |
| bool | ResetAppearanceStream (bool is_generate_new_appearance_obj) |
| 重置外观流。 更多... | |
| void | SetBorderColor (int color) |
| 设置边框颜色。 更多... | |
| void | SetBorderInfo (BorderInfo border) |
| 设置边框信息。 更多... | |
| void | SetContent (string content) |
| 设置内容。 更多... | |
| void | SetFlags (int flags) |
| 设置注释标志。 更多... | |
| void | SetModifiedDateTime (DateTime date_time) |
| 设置最后修改日期时间。 更多... | |
| void | SetUniqueID (string unique_id) |
| 设置唯一ID。 更多... | |
详细描述
插入符号注释（PDF 1.5）是指示文本编辑存在的视觉符号。
插入符号注释是一种标记注释，所以类Caret 派生自 类Markup ，并且还提供获取/设置插入符号注释属性和 重置插入符号注释外观流的函数。
- 注解
- 对于新创建的插入符号注释，如果用户在不设置任何其他属性的情况下 直接调用函数Annot.ResetAppearanceStream ，将使用默认外观：
边框颜色 = 0xFFA7ABE8（一种紫色），不透明度 = 1.0。
- 参见
- Markup
构造及析构函数说明
◆ Caret()
|
inline |
构造函数，使用父类对象。
- 参数
-
[in] annot 父类对象。
成员函数说明
◆ GetInnerRect()
|
inline |
获取内矩形。
此属性对插入符号注释的外观有影响。对于插入符号注释，内矩形意味着 底层插入符号的实际边界。内矩形可以与注释的矩形相同或小于注释的矩形， 并且永远不应大于注释的矩形。
- 返回
- 内矩形。
◆ SetInnerRect()
|
inline |
设置内矩形。
此属性对插入符号注释的外观有影响。对于插入符号注释，内矩形意味着 底层插入符号的实际边界。内矩形可以与注释的矩形相同或小于注释的矩形， 并且永远不应大于注释的矩形。
如果用户希望新内矩形对注释的外观产生影响，请在设置新内矩形后 调用函数Annot.ResetAppearanceStream 。
- 参数
-
[in] inner_rect 要设置的新内矩形。它应该与注释的矩形相同或小于注释的矩形。
- 返回
- 无。
