类 foxit.pdf.annots.Redact 继承关系图:

Public 成员函数
	Redact ()
	构造函数。

	Redact (Annot annot)
	构造函数，使用父类对象。更多...

bool	Apply ()
	应用当前编辑注释：永久移除注释矩形下的文本、图形和注释。更多...

void	EnableAutoFontSize ()
	为覆盖文本启用自动字体大小。更多...

void	EnableRepeatOverlayText (bool is_to_repeat_overlay_text)
	设置标志以决定是否重复覆盖文本。更多...

int	GetApplyFillColor ()
	获取用于翻转外观的填充颜色，将在应用编辑后使用。更多...

DefaultAppearance	GetDefaultAppearance ()
	获取默认外观数据。更多...

int	GetFillColor ()
	获取填充颜色。更多...

string	GetOverlayText ()
	获取覆盖文本。更多...

Alignment	GetOverlayTextAlignment ()
	获取覆盖文本的对齐值。更多...

QuadPointsArray	GetQuadPoints ()
	获取四边形。更多...

bool	IsOverlayTextRepeated ()
	检查覆盖文本是否重复。更多...

void	SetApplyFillColor (int fill_color)
	设置用于翻转外观的填充颜色，将在应用编辑后使用。更多...

bool	SetDefaultAppearance (DefaultAppearance default_ap)
	设置默认外观数据。更多...

void	SetFillColor (int fill_color)
	设置填充颜色。更多...

void	SetOverlayText (string overlay_text)
	设置覆盖文本。更多...

void	SetOverlayTextAlignment (Alignment alignment)
	设置覆盖文本的对齐值。更多...

void	SetQuadPoints (QuadPointsArray quad_points_array)
	设置四边形。更多...

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。更多...

额外继承的成员函数
Public 类型继承自 foxit.pdf.annots.Markup
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注释类型的枚举。更多...

详细描述

类Redact 表示福昕自定义注释类型（不是标准注释类型）。这种注释用于标记PDF页面的一些内容，当编辑注释被应用时，这些内容将被移除。现有的编辑注释可以通过函数 pdf.PDFPage.GetAnnot 和pdf.PDFPage.GetAnnotAtPoint 从PDF页面获取。新的编辑注释由函数addon.Redaction.MarkRedactAnnot 返回，而不是pdf.PDFPage.AddAnnot 。
类foxit.pdf.annots.Redact 派生自类Markup ，还提供获取/设置编辑注释的标记注释基本属性的函数。目前，Annot.SetBorderInfo 可以用于编辑注释，但不会对编辑注释的外观产生任何影响。此外，编辑注释不能通过函数Annot.Move 移动。

参见: foxit.addon.Redaction; foxit.pdf.PDFPage; Markup

构造及析构函数说明

◆ Redact()

foxit.pdf.annots.Redact.Redact ( Annot annot )

inline

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

参数

[in] annot 父类对象。

成员函数说明

◆ Apply()

bool foxit.pdf.annots.Redact.Apply ( )

inline

应用当前编辑注释：永久移除注释矩形下的文本、图形和注释。

一旦此函数成功调用，当前编辑注释矩形区域内的所有页面内容（文本对象、图像对象和路径对象）和注释都将被永久移除。但是，如果其他编辑注释与当前编辑相交或包含在当前编辑内，它们将不会被删除。对于当前编辑注释，它也将被移除（如果有弹出注释的话也一并移除）

这意味着当此函数成功时当前注释对象将变得无用。当前编辑注释矩形的区域将被函数pdf.annots.Redact.SetApplyFillColor 指定的颜色填充。

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

◆ EnableAutoFontSize()

void foxit.pdf.annots.Redact.EnableAutoFontSize ( )

inline

为覆盖文本启用自动字体大小。

返回: 无。

◆ EnableRepeatOverlayText()

void foxit.pdf.annots.Redact.EnableRepeatOverlayText ( bool is_to_repeat_overlay_text )

inline

设置标志以决定是否重复覆盖文本。

参数

[in] is_to_repeat_overlay_text true表示重复覆盖文本，而false表示不重复。默认值：false。

返回: 无。

◆ GetApplyFillColor()

int foxit.pdf.annots.Redact.GetApplyFillColor ( )

inline

获取用于翻转外观的填充颜色，将在应用编辑后使用。

返回: 填充颜色。格式：0xRRGGBB。如果找不到填充颜色，将返回0xFFFFFF。

◆ GetDefaultAppearance()

DefaultAppearance foxit.pdf.annots.Redact.GetDefaultAppearance ( )

inline

获取默认外观数据。

此属性对编辑注释的外观有影响。默认外观数据可用于格式化文本。

返回: 默认外观数据。

◆ GetFillColor()

int foxit.pdf.annots.Redact.GetFillColor ( )

inline

获取填充颜色。

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

◆ GetOverlayText()

string foxit.pdf.annots.Redact.GetOverlayText ( )

inline

获取覆盖文本。

返回: 覆盖文本字符串。

◆ GetOverlayTextAlignment()

Alignment foxit.pdf.annots.Redact.GetOverlayTextAlignment ( )

inline

获取覆盖文本的对齐值。

此属性对编辑注释外观的覆盖文本有影响。

返回: 对齐值。请参考从foxit.common.Alignment.e_AlignmentLeft 开始的值，这将是这些值中的一个。

◆ GetQuadPoints()

QuadPointsArray foxit.pdf.annots.Redact.GetQuadPoints ( )

inline

获取四边形。

四边形中点的顺序应该是：

第一个点是四边形左上角的点。
第二个点是四边形右上角的点。
第三个点是四边形左下角的点。
第四个点是四边形右下角的点。

返回: 接收四边形值的四边形点数组。

◆ IsOverlayTextRepeated()

bool foxit.pdf.annots.Redact.IsOverlayTextRepeated ( )

inline

检查覆盖文本是否重复。

返回: true表示覆盖文本重复，而false表示不重复。

◆ SetApplyFillColor()

void foxit.pdf.annots.Redact.SetApplyFillColor ( int fill_color )

inline

设置用于翻转外观的填充颜色，将在应用编辑后使用。

参数

[in] fill_color 要设置的新填充颜色。格式：0xRRGGBB。

返回: 无。

◆ SetDefaultAppearance()

bool foxit.pdf.annots.Redact.SetDefaultAppearance ( DefaultAppearance default_ap )

inline

设置默认外观数据。

此属性对编辑注释的外观有影响。默认外观数据可用于格式化文本。
如果用户希望新的默认外观数据对注释的外观产生影响，请在设置新的默认外观数据后调用函数Annot.ResetAppearanceStream 。

参数

[in] default_ap 要设置的新默认外观数据。输入数据的flags可用于决定哪些信息将使用新数据更新；对于那些未更新的数据，它们将继续使用旧数据。

返回

true表示成功，而false表示失败。特别地，如果参数default_ap包含任何不正确的值，此函数将返回false，例如：

输入数据的flags包含foxit.pdf.annots.DefaultAppearance.DefAPFlags.e_FlagFont 但输入数据的font无效。
输入数据的flags包含foxit.pdf.annots.DefaultAppearance.DefAPFlags.e_FlagFontSize 但输入数据的text size不大于零。

◆ SetFillColor()

void foxit.pdf.annots.Redact.SetFillColor ( int fill_color )

inline

设置填充颜色。

参数

[in] fill_color 要设置的新填充颜色。格式：0xRRGGBB。

返回: 无。

◆ SetOverlayText()

void foxit.pdf.annots.Redact.SetOverlayText ( string overlay_text )

inline

设置覆盖文本。

参数

[in] overlay_text 要设置的覆盖文本字符串。

返回: 无。

◆ SetOverlayTextAlignment()

void foxit.pdf.annots.Redact.SetOverlayTextAlignment ( Alignment alignment )

inline

设置覆盖文本的对齐值。

此属性对编辑注释外观的覆盖文本有影响。如果用户希望新对齐对注释外观的覆盖文本产生影响，请在设置新对齐后调用函数 Annot.ResetAppearanceStream 。

参数

[in] alignment 新的对齐值。请参考从foxit.common.Alignment.e_AlignmentLeft 开始的值，这应该是这些值中的一个。

返回: 无。

◆ SetQuadPoints()

void foxit.pdf.annots.Redact.SetQuadPoints ( QuadPointsArray quad_points_array )

inline

设置四边形。

此属性对编辑注释的外观有影响。四边形中点的顺序应该是：

第一个点是四边形左上角的点。
第二个点是四边形右上角的点。
第三个点是四边形左下角的点。
第四个点是四边形右下角的点。

如果用户希望新四边形对注释的外观产生影响，请在设置四边形后调用函数Annot.ResetAppearanceStream 。

参数

[in] quad_points_array 有效的四边形数组。它不应该是空数组。

返回: 无。

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ Redact()

成员函数说明

◆ Apply()

◆ EnableAutoFontSize()

◆ EnableRepeatOverlayText()

◆ GetApplyFillColor()

◆ GetDefaultAppearance()

◆ GetFillColor()

◆ GetOverlayText()

◆ GetOverlayTextAlignment()

◆ GetQuadPoints()

◆ IsOverlayTextRepeated()

◆ SetApplyFillColor()

◆ SetDefaultAppearance()

◆ SetFillColor()

◆ SetOverlayText()

◆ SetOverlayTextAlignment()

◆ SetQuadPoints()