Foxit PDF SDK
foxit.pdf.annots.Markup类 参考
类 foxit.pdf.annots.Markup 继承关系图:
foxit.pdf.annots.Annot foxit.common.Base foxit.pdf.annots.Caret foxit.pdf.annots.Circle foxit.pdf.annots.FileAttachment foxit.pdf.annots.FreeText foxit.pdf.annots.Ink foxit.pdf.annots.Line foxit.pdf.annots.Note foxit.pdf.annots.Polygon foxit.pdf.annots.PolyLine foxit.pdf.annots.Redact foxit.pdf.annots.Sound foxit.pdf.annots.Square foxit.pdf.annots.Stamp foxit.pdf.annots.TextMarkup

Public 类型

enum  EndingStyle {
  EndingStyle.e_EndingStyleNone = 0, EndingStyle.e_EndingStyleSquare = 1, EndingStyle.e_EndingStyleCircle = 2, EndingStyle.e_EndingStyleDiamond = 3,
  EndingStyle.e_EndingStyleOpenArrow = 4, EndingStyle.e_EndingStyleClosedArrow = 5, EndingStyle.e_EndingStyleButt = 6, EndingStyle.e_EndingStyleROpenArrow = 7,
  EndingStyle.e_EndingStyleRClosedArrow = 8, EndingStyle.e_EndingStyleSlash = 9
}
 线条端点样式的枚举。 更多...
 
enum  MeasureType {
  MeasureType.e_MeasureTypeX = 0, MeasureType.e_MeasureTypeY = 1, MeasureType.e_MeasureTypeD = 2, MeasureType.e_MeasureTypeA = 3,
  MeasureType.e_MeasureTypeT = 4, MeasureType.e_MeasureTypeS = 5
}
 注释测量类型的枚举。 更多...
 
enum  State {
  State.e_StateNone = 0, State.e_StateMarked = 1, State.e_StateUnmarked = 2, State.e_StateAccepted = 3,
  State.e_StateRejected = 4, State.e_StateCancelled = 5, State.e_StateCompleted = 6, State.e_StateDeferred = 7,
  State.e_StateFuture = 8
}
 标记注释状态的枚举。 更多...
 
enum  StateModel { StateModel.e_StateModelMarked = 1, StateModel.e_StateModelReview = 2 }
 标记注释状态模型的枚举。 更多...
 
- Public 类型 继承自 foxit.pdf.annots.Annot
enum  AppearanceType { AppearanceType.e_AppearanceTypeNormal = 0, AppearanceType.e_AppearanceTypeRollover = 1, AppearanceType.e_AppearanceTypeDown = 2 }
 注释外观类型的枚举。 更多...
 
enum  Flags {
  Flags.e_FlagInvisible = 0x0001, Flags.e_FlagHidden = 0x0002, Flags.e_FlagPrint = 0x0004, Flags.e_FlagNoZoom = 0x0008,
  Flags.e_FlagNoRotate = 0x0010, Flags.e_FlagNoView = 0x0020, Flags.e_FlagReadOnly = 0x0040, Flags.e_FlagLocked = 0x0080,
  Flags.e_FlagToggleNoView = 0x0100, Flags.e_FlagLockedContents = 0x0200
}
 PDF注释标志的枚举。 更多...
 
enum  HighlightingMode {
  HighlightingMode.e_HighlightingNone = 0, HighlightingMode.e_HighlightingInvert = 1, HighlightingMode.e_HighlightingOutline = 2, HighlightingMode.e_HighlightingPush = 3,
  HighlightingMode.e_HighlightingToggle = 4
}
 PDF注释高亮模式的枚举。 更多...
 
enum  MKEntry {
  MKEntry.e_MKEntryRotation = 0, MKEntry.e_MKEntryBorderColor = 1, MKEntry.e_MKEntryBackgroundColor = 2, MKEntry.e_MKEntryNormalCaption = 3,
  MKEntry.e_MKEntryRolloverCaption = 4, MKEntry.e_MKEntryDownCaption = 5, MKEntry.e_MKEntryNormalIcon = 6, MKEntry.e_MKEntryRolloverIcon = 7,
  MKEntry.e_MKEntryDownIcon = 8, MKEntry.e_MKEntryIconFit = 9, MKEntry.e_MKEntryIconCaptionRelation = 10
}
 注释MK字典(外观特征)条目的枚举。 更多...
 
enum  MKIconCaptionRelation {
  MKIconCaptionRelation.e_MKRelationNoIcon = 0, MKIconCaptionRelation.e_MKRelationNoCaption = 1, MKIconCaptionRelation.e_MKRelationCaptionBelowIcon = 2, MKIconCaptionRelation.e_MKRelationCaptionAboveIcon = 3,
  MKIconCaptionRelation.e_MKRelationCaptionRight = 4, MKIconCaptionRelation.e_MKRelationCaptionLeft = 5, MKIconCaptionRelation.e_MKRelationCaptionOvrlayOnIcon = 6
}
 注释MK字典中图标和标题相对位置的枚举。 更多...
 
enum  Property { Property.e_PropertyModifiedDate = 0, Property.e_PropertyCreationDate = 1, Property.e_PropertyBorderColor = 2, Property.e_PropertyFillColor = 3 }
 某些PDF注释属性的枚举。 更多...
 
enum  Type {
  Type.e_UnknownType = 0, Type.e_Note = 1, Type.e_Link = 2, Type.e_FreeText = 3,
  Type.e_Line = 4, Type.e_Square = 5, Type.e_Circle = 6, Type.e_Polygon = 7,
  Type.e_PolyLine = 8, Type.e_Highlight = 9, Type.e_Underline = 10, Type.e_Squiggly = 11,
  Type.e_StrikeOut = 12, Type.e_Stamp = 13, Type.e_Caret = 14, Type.e_Ink = 15,
  Type.e_PSInk = 16, Type.e_FileAttachment = 17, Type.e_Sound = 18, Type.e_Movie = 19,
  Type.e_Widget = 20, Type.e_Screen = 21, Type.e_PrinterMark = 22, Type.e_TrapNet = 23,
  Type.e_Watermark = 24, Type.e_3D = 25, Type.e_Popup = 26, Type.e_Redact = 27,
  Type.e_RichMedia = 28, Type.e_PagingSeal = 29
}
 PDF注释类型的枚举。 更多...
 

Public 成员函数

 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文档。这些注释包含文本, 作为注释的一部分出现,并且可能由查看器应用程序以其他方式显示,例如在注释窗格中。
foxit.pdf.annots.Markup 派生自类Annot ,也是所有PDF标记注释的基类。 它提供获取/设置标记注释公共属性的基础函数。 对于具体的标记注释类型,请参考派生类。
函数Annot.IsMarkup 可用于判断注释是否为标记注释。

注解
目前,以下类型的函数仅支持注记、高亮、下划线、删除线、波浪线、 矩形、圆形、自由文本、印章、插入符、墨迹、直线、多边形、折线、文件附件注释:
参见
Annot

成员枚举类型说明

◆ EndingStyle

线条端点样式的枚举。

此枚举的值应单独使用。

枚举值
e_EndingStyleNone 

无特殊线条端点。

e_EndingStyleSquare 

用注释的内部颜色填充的正方形(如果有)。

e_EndingStyleCircle 

用注释的内部颜色填充的圆形(如果有)。

e_EndingStyleDiamond 

用注释的内部颜色填充的菱形(如果有)。

e_EndingStyleOpenArrow 

两条短线以锐角相交形成开放箭头。

e_EndingStyleClosedArrow 

两条短线以锐角相交(如OpenArrow样式),并由第三条线连接, 形成用注释的内部颜色填充的三角形闭合箭头(如果有)。

e_EndingStyleButt 

端点处垂直于线条本身的短线。

e_EndingStyleROpenArrow 

与OpenArrow方向相反的两条短线。

e_EndingStyleRClosedArrow 

与ClosedArrow方向相反的三角形闭合箭头。

e_EndingStyleSlash 

端点处与线条垂直方向约顺时针30度的短线。

◆ MeasureType

注释测量类型的枚举。

此枚举的值应单独使用。

枚举值
e_MeasureTypeX 

沿x轴变化的测量。

e_MeasureTypeY 

沿y轴变化的测量。

e_MeasureTypeD 

任意方向距离的测量。

e_MeasureTypeA 

面积的测量。

e_MeasureTypeT 

角度的测量。

e_MeasureTypeS 

直线斜率的测量。

◆ State

标记注释状态的枚举。

此枚举的值应单独使用。

枚举值
e_StateNone 

(与状态模型foxit.pdf.annots.Markup.StateModel.e_StateModelReview 一起使用) 用户没有对更改表示任何意见。

e_StateMarked 

(与状态模型foxit.pdf.annots.Markup.StateModel.e_StateModelMarked 一起使用) 注释已被用户标记。

e_StateUnmarked 

(与状态模型foxit.pdf.annots.Markup.StateModel.e_StateModelMarked 一起使用) 注释尚未被用户标记。

e_StateAccepted 

(与状态模型foxit.pdf.annots.Markup.StateModel.e_StateModelReview 一起使用) 用户同意更改。

e_StateRejected 

(与状态模型foxit.pdf.annots.Markup.StateModel.e_StateModelReview 一起使用) 用户不同意更改。

e_StateCancelled 

(与状态模型foxit.pdf.annots.Markup.StateModel.e_StateModelReview 一起使用) 更改已被取消。

e_StateCompleted 

(与状态模型foxit.pdf.annots.Markup.StateModel.e_StateModelReview 一起使用) 更改已完成。

e_StateDeferred 

(与状态模型foxit.pdf.annots.Markup.StateModel.e_StateModelReview 一起使用) 更改已延期。

e_StateFuture 

(与状态模型foxit.pdf.annots.Markup.StateModel.e_StateModelReview 一起使用) 更改将在将来进行。

◆ StateModel

标记注释状态模型的枚举。

此枚举的值应单独使用。

枚举值
e_StateModelMarked 

标记注释状态模型:已标记。

e_StateModelReview 

标记注释状态模型:审阅。

构造及析构函数说明

◆ Markup()

foxit.pdf.annots.Markup.Markup ( Annot  annot)
inline

构造函数,使用父类对象。

参数
[in]annot父类对象。

成员函数说明

◆ AddReply()

Note foxit.pdf.annots.Markup.AddReply ( )
inline

在回复列表的末尾添加新回复。

返回
表示新回复注释的新便签注释。

◆ AddRichText()

void foxit.pdf.annots.Markup.AddRichText ( string  content,
RichTextStyle  style 
)
inline

在末尾添加新的富文本字符串。

标记注释的内容可以由多个富文本字符串组成。 特别地,如果当前注释是自由文本且其意图是"FreeTextTypewriter",输入样式的文本对齐方式将 被设置给当前自由文本注释的所有富文本字符串。

参数
[in]content用作新富文本字符串内容的文本字符串。这不应是空字符串。
[in]style用于新富文本字符串的样式数据。
返回
无。

◆ AddStateAnnot()

Note foxit.pdf.annots.Markup.AddStateAnnot ( string  title,
Markup.StateModel  model,
Markup.State  state 
)
inline

添加新的状态注释。

标记注释可能有一个或多个与其关联的作者特定状态。每个状态不是在注释本身中指定的, 而是在单独的注记注释中指定的。

参数
[in]title新状态注释的标题。标题可用于识别添加当前注释的用户。 这可以是空字符串,但强烈建议用户在使用此函数时设置有意义的标题。
[in]model新状态注释的状态模型。应为以下值之一:
[in]state新状态注释的状态值。应为以下值之一:
返回
表示新状态注释的注记注释。返回的状态注释的最后修改日期时间 默认情况下将设置为当前本地系统时间。

◆ GetBorderOpacity()

float foxit.pdf.annots.Markup.GetBorderOpacity ( )
inline

获取注释的边框透明度。

返回
透明度值。有效范围:0.0 到 1.0。 0.0 表示完全透明,1.0 表示完全不透明。

◆ GetCreationDateTime()

DateTime foxit.pdf.annots.Markup.GetCreationDateTime ( )
inline

获取创建日期时间。

返回
接收创建日期时间的日期和时间对象。 如果没有创建日期时间信息,将返回所有值为 0 的日期和时间对象。

◆ GetFillOpacity()

float foxit.pdf.annots.Markup.GetFillOpacity ( )
inline

获取注释的填充透明度。

返回
透明度值。有效范围:0.0 到 1.0。 0.0 表示完全透明,1.0 表示完全不透明。

◆ GetGroupElements()

MarkupArray foxit.pdf.annots.Markup.GetGroupElements ( )
inline

从当前标记注释所属的组中获取一个元素(作为标记注释)。

标记注释可以分组。组由一个主注释和一个或多个从属注释组成。 主注释中的一些条目被视为应适用于整个组的组属性; 从属注释中的相应条目应被忽略。这些条目包括内容、最后修改时间、填充颜色/边框颜色、 标题、弹出注释、创建时间、主题和打开状态。因此用户应尊重 组属性:当组中注释的属性发生更改时,同一组中的其他注释也应进行更改。
操作组中任何注释的操作,如移动、剪切和复制,查看器应用程序应将其视为 作用于整个组。

返回
包含组中所有标记注释的数组。 如果当前注释不属于组,此函数将返回空数组。

◆ GetGroupHeader()

Markup foxit.pdf.annots.Markup.GetGroupHeader ( )
inline

获取当前标记注释所属组的头注释(作为主注释)。

标记注释可以分组。组由一个主注释和一个或多个从属注释组成。 主注释中的一些条目被视为应适用于整个组的组属性; 从属注释中的相应条目应被忽略。这些条目包括内容、最后修改时间、填充颜色/边框颜色、 标题、弹出注释、创建时间、主题和打开状态。因此用户应尊重 组属性:当组中注释的属性发生更改时,同一组中的其他注释也应进行更改。
操作组中任何注释的操作,如移动、剪切和复制,查看器应用程序应将其视为 作用于整个组。

返回
当前标记注释所属组的头标记注释。 如果返回的标记注释对象的函数 Annot.IsEmpty (从 Markup 的父类继承) 的返回值为 true,则表示当前注释不属于组。

◆ GetIntent()

string foxit.pdf.annots.Markup.GetIntent ( )
inline

获取意图名称。

以下注释类型具有预定义的意图名称:

  • 自由文本注释的预定义意图名称:"FreeTextCallout"、"FreeTextTypewriter"。 如果未使用意图名称,自由文本注释将显示为文本框。

  • 直线注释的预定义意图名称:"LineArrow"、"LineDimension"。 如果未使用意图名称,直线注释将显示为普通直线。

  • 多边形的预定义意图名称:"PolygonCloud"、"PolygonDimension"。 如果未使用意图名称,多边形注释将显示为普通多边形。

  • 折线注释的预定义意图名称:"PolyLineDimension"。 如果未使用意图名称,折线注释将显示为普通折线。

返回
意图名称字符串。

◆ GetOpacity()

float foxit.pdf.annots.Markup.GetOpacity ( )
inline

获取不透明度值。

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

返回
不透明度值。有效范围:0.0 到 1.0。 0.0 表示完全透明,1.0 表示完全不透明。

◆ GetPopup()

Popup foxit.pdf.annots.Markup.GetPopup ( )
inline

获取相关的弹出注释。

大多数标记注释都可以有弹出注释来显示其内容,除了声音和自由文本注释:

  • 声音注释没有弹出注释。

  • 自由文本注释直接在页面上显示文本,因此不需要弹出注释。

尽管在某些特殊(或错误)的PDF文档中,声音或自由文本注释可能有弹出注释, 但它们仍然不需要弹出注释。

返回
相关的弹出注释。如果返回的弹出注释的函数 Annot.IsEmpty (从 Popup 的父类继承)的返回值为 true, 则表示当前标记注释没有弹出注释。

◆ GetReply()

Note foxit.pdf.annots.Markup.GetReply ( int  index)
inline

按索引获取回复。

参数
[in]index指定回复的索引。有效范围:从 0 到 (count-1)。 count 由函数 Markup.GetReplyCount 返回。
返回
表示指定回复注释的便签注释。

◆ GetReplyCount()

int foxit.pdf.annots.Markup.GetReplyCount ( )
inline

计算所有回复。

返回
回复的数量。

◆ GetRichTextContent()

string foxit.pdf.annots.Markup.GetRichTextContent ( int  index)
inline

获取指定索引的富文本字符串的文本字符串。

标记注释的内容可以由多个富文本字符串组成。

参数
[in]index要检索其内容的富文本字符串的索引。有效范围:从 0 到(count-1)。 count 由函数 Markup.GetRichTextCount 返回。
返回
指定富文本的文本字符串。

◆ GetRichTextCount()

int foxit.pdf.annots.Markup.GetRichTextCount ( )
inline

获取富文本字符串的数量。

标记注释的内容可以由多个富文本字符串组成。

返回
富文本字符串的数量。

◆ GetRichTextStyle()

RichTextStyle foxit.pdf.annots.Markup.GetRichTextStyle ( int  index)
inline

获取指定索引的富文本字符串的样式数据。

标记注释的内容可以由多个富文本字符串组成。

参数
[in]index要检索其样式数据的富文本字符串的索引。有效范围:从 0 到(count-1)。 count 由函数 Markup.GetRichTextCount 返回。
返回
指定富文本字符串的样式数据。

◆ GetStateAnnots()

NoteArray foxit.pdf.annots.Markup.GetStateAnnots ( Markup.StateModel  model)
inline

获取指定状态模型中的所有状态注释。

标记注释可能有一个或多个与其关联的作者特定状态。每个状态不是在注释本身中指定的, 而是在单独的注记注释中指定的。

参数
[in]model状态模型。应为以下值之一:
返回
表示指定状态模型中所有状态注释的注记注释数组。 此数组中的所有注释将按时间顺序排列。

◆ GetSubject()

string foxit.pdf.annots.Markup.GetSubject ( )
inline

获取主题字符串。

返回
主题字符串。

◆ GetTitle()

string foxit.pdf.annots.Markup.GetTitle ( )
inline

获取标题字符串。

按惯例,注释的标题可用于识别添加当前注释的用户。

返回
标题字符串。

◆ InsertRichText()

void foxit.pdf.annots.Markup.InsertRichText ( int  index,
string  content,
RichTextStyle  style 
)
inline

在指定索引位置插入新的富文本字符串。

标记注释的内容可以由多个富文本字符串组成。 特别地,如果当前注释是自由文本且其意图是"FreeTextTypewriter",输入样式的文本对齐方式将 被设置给当前自由文本注释的所有富文本字符串。

参数
[in]index要在其处插入富文本字符串的样式数据的索引。有效范围:从 0 到 countcount 由函数 Markup.GetRichTextCount 返回。
如果输入值等于富文本字符串数量,这意味着将新富文本字符串添加到末尾。 在这种情况下,此函数等同于函数 Markup.AddRichText
[in]content用作新富文本字符串内容的文本字符串。这不应是空字符串。
[in]style用于新富文本字符串的样式数据。
返回
无。

◆ IsGrouped()

bool foxit.pdf.annots.Markup.IsGrouped ( )
inline

检查当前标记注释是否在组中。

标记注释可以分组。组由一个主注释和一个或多个从属注释组成。 主注释中的一些条目被视为应适用于整个组的组属性; 从属注释中的相应条目应被忽略。这些条目包括内容、最后修改时间、填充颜色/边框颜色、 标题、弹出注释、创建时间、主题和打开状态。因此用户应尊重 组属性:当组中注释的属性发生更改时,同一组中的其他注释也应进行更改。
操作组中任何注释的操作,如移动、剪切和复制,查看器应用程序应将其视为 作用于整个组。

返回
true 表示当前标记注释在组中。 false 表示当前标记注释不属于任何组。

◆ RemoveAllReplies()

bool foxit.pdf.annots.Markup.RemoveAllReplies ( )
inline

删除所有回复。

返回
true 表示成功,false 表示失败。

◆ RemoveAllStateAnnots()

bool foxit.pdf.annots.Markup.RemoveAllStateAnnots ( )
inline

移除所有状态注释。

状态注释由注记注释表示,因此移除状态注释意味着 从页面中移除此类注记注释(及其弹出注释,如果有的话)。

返回
true 表示成功移除所有状态注释或当前注释没有任何状态注释, false 表示失败。

◆ RemovePopup()

bool foxit.pdf.annots.Markup.RemovePopup ( )
inline

删除相关的弹出注释。

返回
true表示相关的弹出注释被成功删除, 而false表示当前标记注释没有相关的弹出注释。

◆ RemoveReply()

bool foxit.pdf.annots.Markup.RemoveReply ( int  index)
inline

按索引删除回复。

如果指定的回复有自己的回复,这些子回复将同时被删除。

参数
[in]index要删除的指定回复的索引。有效范围:从 0 到 (count-1)。 count 由函数 Markup.GetReplyCount 返回。
返回
true 表示成功,false 表示失败。

◆ RemoveRichText()

void foxit.pdf.annots.Markup.RemoveRichText ( int  index)
inline

移除指定索引的富文本字符串。

标记注释的内容可以由多个富文本字符串组成。

参数
[in]index要在其处插入样式数据的富文本字符串的索引。有效范围:从 0 到(count-1)。 count 由函数 Markup.GetRichTextCount 返回。
返回
无。

◆ SetBorderOpacity()

void foxit.pdf.annots.Markup.SetBorderOpacity ( float  opacity)
inline

设置注释的边框透明度。

此属性影响标记注释的外观。如果用户希望新的透明度值对注释外观产生效果, 请在设置新透明度值后调用函数 Annot.ResetAppearanceStream

参数
[in]opacity新的透明度值。有效范围:0.0 到 1.0。 0.0 means full transparency and 1.0 means full opaque.
返回
None.

◆ SetCreationDateTime()

void foxit.pdf.annots.Markup.SetCreationDateTime ( DateTime  date_time)
inline

设置创建日期时间。

参数
[in]date_time要设置的新日期时间。
返回
无。

◆ SetFillOpacity()

void foxit.pdf.annots.Markup.SetFillOpacity ( float  opacity)
inline

设置注释的填充透明度。

此属性影响标记注释的外观。如果用户希望新的透明度值对注释外观产生效果, 请在设置新透明度值后调用函数 Annot.ResetAppearanceStream

参数
[in]opacity新的透明度值。有效范围:0.0 到 1.0。 0.0 表示完全透明,1.0 表示完全不透明。
返回
无。

◆ SetIntent()

void foxit.pdf.annots.Markup.SetIntent ( string  intent)
inline

设置意图名称。

以下注释类型具有预定义的意图名称:

  • 自由文本注释的预定义意图名称:"FreeTextCallout"、"FreeTextTypewriter"。 如果未使用意图名称,自由文本注释将显示为文本框。 如果意图名称为 FreeTextTypewriter,边框颜色将被移除。

  • 直线注释的预定义意图名称:"LineArrow"、"LineDimension"。 如果未使用意图名称,直线注释将显示为普通直线。
    如果直线注释的意图设置为"LineArrow",直线注释的线条结束样式 将默认为起点 foxit.pdf.annots.Markup.EndingStyle.e_EndingStyleNone 和 终点 foxit.pdf.annots.Markup.EndingStyle.e_EndingStyleOpenArrow

  • 多边形的预定义意图名称:"PolygonCloud"、"PolygonDimension"。 如果未使用意图名称,多边形注释将显示为普通多边形。
    如果多边形注释的意图设置为"PolygonCloud",多边形注释的 边框样式将更改为 foxit.pdf.annots.BorderInfo.Style.e_Cloudy , 边框云状强度将默认设置为 2。

  • 折线注释的预定义意图名称:"PolyLineDimension"。 如果未使用意图名称,折线注释将显示为普通折线。

如果已为相应类型的注释设置了支持的预定义意图名称,用户应调用 函数 Annot.ResetAppearanceStream 以在注释外观上产生效果。

参数
[in]intent要设置的新意图名称字符串。如果为空字符串,则表示不会使用意图属性。
某些注释类型具有预定义的意图名称,请参考"详细信息"部分了解更多详情。 如果此字符串是不支持的意图名称之一,设置到相应注释时将忽略此字符串。
返回
无。

◆ SetOpacity()

void foxit.pdf.annots.Markup.SetOpacity ( float  opacity)
inline

设置不透明度值。

此属性对标记注释的外观有影响。如果用户希望新的不透明度值对 注释的外观有影响,请在设置新不透明度值后调用函数 Annot.ResetAppearanceStream

参数
[in]opacity新的不透明度值。有效范围:0.0 到 1.0。 0.0 表示完全透明,1.0 表示完全不透明。
返回
无。

◆ SetPopup()

void foxit.pdf.annots.Markup.SetPopup ( Popup  popup)
inline

设置相关的弹出注释。

大多数标记注释都可以有弹出注释来显示其内容,除了声音和自由文本注释:

  • 声音注释没有弹出注释。

  • 自由文本注释直接在页面上显示文本,因此不需要弹出注释。

因此,此函数不允许为声音和自由文本注释设置弹出注释。

参数
[in]popup要设置到当前标记注释的有效弹出注释。
返回
无。

◆ SetRichTextContent()

void foxit.pdf.annots.Markup.SetRichTextContent ( int  index,
string  content 
)
inline

设置指定索引的富文本字符串的文本字符串。

标记注释的内容可以由多个富文本字符串组成。

参数
[in]index要设置其内容的富文本字符串的索引。有效范围:从 0 到(count-1)。 count 由函数 Markup.GetRichTextCount 返回。
[in]content要设置为指定富文本内容的文本字符串。这不应是空字符串。
返回
无。

◆ SetRichTextStyle()

void foxit.pdf.annots.Markup.SetRichTextStyle ( int  index,
RichTextStyle  style 
)
inline

设置指定索引的富文本字符串的样式数据。

标记注释的内容可以由多个富文本字符串组成。
特别地,如果当前注释是自由文本且其意图是"FreeTextTypewriter",输入样式的文本对齐方式将 被设置给当前自由文本注释的所有富文本字符串。

参数
[in]index要检索其样式数据的富文本字符串的索引。有效范围:从 0 到(count-1)。 count 由函数 Markup.GetRichTextCount 返回。
[in]style用于设置到指定富文本的样式数据。
返回
无。

◆ SetSubject()

void foxit.pdf.annots.Markup.SetSubject ( string  subject)
inline

设置主题字符串。

参数
[in]subject要设置的新主题字符串。
返回
无。

◆ SetTitle()

void foxit.pdf.annots.Markup.SetTitle ( string  title)
inline

设置标题字符串。

按惯例,注释的标题可用于识别添加当前注释的用户。

参数
[in]title要设置的新标题字符串。
返回
无。

◆ Ungroup()

bool foxit.pdf.annots.Markup.Ungroup ( )
inline

将当前标记注释从其所属的组中解组。

  • 如果当前标记注释只是组头,此函数将解散整个组。

  • 如果当前标记注释只是组的成员,此函数将仅将当前标记注释从其所属的组中解组。

  • 如果当前标记注释不属于任何组,此函数将不执行任何操作并直接返回 false

返回
true 表示成功,false 表示当前标记注释不属于任何组。