foxit::pdf::annots::Redact类 参考

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

Public 成员函数
	Redact ()
	构造函数。
	Redact (const Annot &annot)
	构造函数，使用父类对象。 更多...
	~Redact ()
	析构函数。
bool	Apply ()
	应用当前编辑注释：永久移除注释矩形下的文本、图形和注释。 更多...
void	EnableAutoFontSize ()
	为覆盖文本启用自动字体大小。 更多...
void	EnableRepeatOverlayText (bool is_to_repeat_overlay_text)
	设置标志以决定是否重复覆盖文本。 更多...
RGB	GetApplyFillColor () const
	获取用于翻转外观的填充颜色，将在应用编辑后使用。 更多...
DefaultAppearance	GetDefaultAppearance ()
	获取默认外观数据。 更多...
RGB	GetFillColor () const
	获取填充颜色。 更多...
WString	GetOverlayText () const
	获取覆盖文本。 更多...
common::Alignment	GetOverlayTextAlignment () const
	获取覆盖文本的对齐值。 更多...
QuadPointsArray	GetQuadPoints () const
	获取四边形。 更多...
bool	IsOverlayTextRepeated ()
	检查覆盖文本是否重复。 更多...
void	SetApplyFillColor (RGB fill_color)
	设置用于翻转外观的填充颜色，将在应用编辑后使用。 更多...
bool	SetDefaultAppearance (const DefaultAppearance &default_ap)
	设置默认外观数据。 更多...
void	SetFillColor (RGB fill_color)
	设置填充颜色。 更多...
void	SetOverlayText (const WString &overlay_text)
	设置覆盖文本。 更多...
void	SetOverlayTextAlignment (common::Alignment alignment)
	设置覆盖文本的对齐值。 更多...
void	SetQuadPoints (const QuadPointsArray &quad_points_array)
	设置四边形。 更多...
Public 成员函数 继承自 foxit::pdf::annots::Markup
	Markup (const Annot &annot)
	构造函数，使用父类对象。 更多...
	Markup ()
	构造函数
	~Markup ()
	析构函数。
Note	AddReply ()
	在回复列表的末尾添加新回复。 更多...
void	AddRichText (const WString &content, const RichTextStyle &style)
	在末尾添加新的富文本字符串。 更多...
Note	AddStateAnnot (const WString &title, StateModel model, State state)
	添加新的状态注释。 更多...
float	GetBorderOpacity () const
	获取注释的边框透明度。 更多...
DateTime	GetCreationDateTime () const
	获取创建日期时间。 更多...
float	GetFillOpacity () const
	获取注释的填充透明度。 更多...
MarkupArray	GetGroupElements ()
	从当前标记注释所属的组中获取一个元素（作为标记注释）。 更多...
Markup	GetGroupHeader ()
	获取当前标记注释所属组的头注释（作为主注释）。 更多...
String	GetIntent () const
	获取意图名称。 更多...
float	GetOpacity () const
	获取不透明度值。 更多...
Popup	GetPopup ()
	获取相关的弹出注释。 更多...
Note	GetReply (int index) const
	按索引获取回复。 更多...
int	GetReplyCount ()
	计算所有回复。 更多...
WString	GetRichTextContent (int32 index)
	获取指定索引的富文本字符串的文本字符串。 更多...
int32	GetRichTextCount ()
	获取富文本字符串的数量。 更多...
RichTextStyle	GetRichTextStyle (int32 index)
	获取指定索引的富文本字符串的样式数据。 更多...
NoteArray	GetStateAnnots (StateModel model)
	获取指定状态模型中的所有状态注释。 更多...
WString	GetSubject () const
	获取主题字符串。 更多...
WString	GetTitle () const
	获取标题字符串。 更多...
void	InsertRichText (int32 index, const WString &content, const RichTextStyle &style)
	在指定索引位置插入新的富文本字符串。 更多...
bool	IsGrouped ()
	检查当前标记注释是否在组中。 更多...
bool	RemoveAllReplies ()
	删除所有回复。 更多...
bool	RemoveAllStateAnnots ()
	移除所有状态注释。 更多...
bool	RemovePopup ()
	删除相关的弹出注释。 更多...
bool	RemoveReply (int index)
	按索引删除回复。 更多...
void	RemoveRichText (int index)
	移除指定索引的富文本字符串。 更多...
void	SetBorderOpacity (float opacity)
	设置注释的边框透明度。 更多...
void	SetCreationDateTime (const DateTime &date_time)
	设置创建日期时间。 更多...
void	SetFillOpacity (float opacity)
	设置注释的填充透明度。 更多...
void	SetIntent (const String &intent)
	设置意图名称。 更多...
void	SetOpacity (float opacity)
	设置不透明度值。 更多...
void	SetPopup (const Popup &popup)
	设置相关的弹出注释。 更多...
void	SetRichTextContent (int32 index, const WString &content)
	设置指定索引的富文本字符串的文本字符串。 更多...
void	SetRichTextStyle (int32 index, const RichTextStyle &style)
	设置指定索引的富文本字符串的样式数据。 更多...
void	SetSubject (const WString &subject)
	设置主题字符串。 更多...
void	SetTitle (const WString &title)
	设置标题字符串。 更多...
bool	Ungroup ()
	将当前标记注释从其所属的组中解组。 更多...
Public 成员函数 继承自 foxit::pdf::annots::Annot
	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
	获取当前对象的句柄。 更多...

额外继承的成员函数
Public 类型 继承自 foxit::pdf::annots::Markup
enum	EndingStyle {   e_EndingStyleNone = 0, e_EndingStyleSquare = 1, e_EndingStyleCircle = 2, e_EndingStyleDiamond = 3,   e_EndingStyleOpenArrow = 4, e_EndingStyleClosedArrow = 5, e_EndingStyleButt = 6, e_EndingStyleROpenArrow = 7,   e_EndingStyleRClosedArrow = 8, e_EndingStyleSlash = 9 }
	线条端点样式的枚举。 更多...
enum	MeasureType {   e_MeasureTypeX = 0, e_MeasureTypeY = 1, e_MeasureTypeD = 2, e_MeasureTypeA = 3,   e_MeasureTypeT = 4, e_MeasureTypeS = 5 }
	注释测量类型的枚举。 更多...
enum	State {   e_StateNone = 0, e_StateMarked = 1, e_StateUnmarked = 2, e_StateAccepted = 3,   e_StateRejected = 4, e_StateCancelled = 5, e_StateCompleted = 6, e_StateDeferred = 7,   e_StateFuture = 8 }
	标记注释状态的枚举。 更多...
enum	StateModel { e_StateModelMarked = 1, e_StateModelReview = 2 }
	标记注释状态模型的枚举。 更多...
Public 类型 继承自 foxit::pdf::annots::Annot
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注释类型的枚举。 更多...

详细描述

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

参见

addon::Redaction

pdf::PDFPage

Markup

构造及析构函数说明

Redact()

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

explicit

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

参数

[in]

annot

父类对象。

成员函数说明

Apply()

bool foxit::pdf::annots::Redact::Apply

(

)

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

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

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

返回

true表示成功，而false表示失败。

EnableAutoFontSize()

void foxit::pdf::annots::Redact::EnableAutoFontSize

(

)

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

返回

无。

EnableRepeatOverlayText()

void foxit::pdf::annots::Redact::EnableRepeatOverlayText

(

bool

is_to_repeat_overlay_text

)

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

参数

[in]

is_to_repeat_overlay_text

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

返回

无。

GetApplyFillColor()

RGB foxit::pdf::annots::Redact::GetApplyFillColor

(

)

const

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

返回

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

GetDefaultAppearance()

DefaultAppearance foxit::pdf::annots::Redact::GetDefaultAppearance

(

)

获取默认外观数据。

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

返回

默认外观数据。

GetFillColor()

RGB foxit::pdf::annots::Redact::GetFillColor

(

)

const

获取填充颜色。

返回

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

GetOverlayText()

WString foxit::pdf::annots::Redact::GetOverlayText

(

)

const

获取覆盖文本。

返回

覆盖文本字符串。

GetOverlayTextAlignment()

common::Alignment foxit::pdf::annots::Redact::GetOverlayTextAlignment

(

)

const

获取覆盖文本的对齐值。

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

返回

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

GetQuadPoints()

QuadPointsArray foxit::pdf::annots::Redact::GetQuadPoints

(

)

const

获取四边形。

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

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

返回

接收四边形值的四边形点数组。

IsOverlayTextRepeated()

bool foxit::pdf::annots::Redact::IsOverlayTextRepeated

(

)

检查覆盖文本是否重复。

返回

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

SetApplyFillColor()

void foxit::pdf::annots::Redact::SetApplyFillColor

(

RGB

fill_color

)

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

参数

[in]

fill_color

要设置的新填充颜色。格式：0xRRGGBB。

返回

无。

SetDefaultAppearance()

bool foxit::pdf::annots::Redact::SetDefaultAppearance

(

const DefaultAppearance &

default_ap

)

设置默认外观数据。

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

参数

[in]

default_ap

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

返回

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

• 输入数据的flags包含DefaultAppearance::e_FlagFont 但输入数据的font无效。
• 输入数据的flags包含DefaultAppearance::e_FlagFontSize 但输入数据的text size不大于零。

SetFillColor()

void foxit::pdf::annots::Redact::SetFillColor

(

RGB

fill_color

)

设置填充颜色。

参数

[in]

fill_color

要设置的新填充颜色。格式：0xRRGGBB。

返回

无。

SetOverlayText()

void foxit::pdf::annots::Redact::SetOverlayText

(

const WString &

overlay_text

)

设置覆盖文本。

参数

[in]

overlay_text

要设置的覆盖文本字符串。

返回

无。

SetOverlayTextAlignment()

void foxit::pdf::annots::Redact::SetOverlayTextAlignment

(

common::Alignment

alignment

)

设置覆盖文本的对齐值。

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

参数

[in]

alignment

新的对齐值。请参考从common::e_AlignmentLeft开始的值， 这应该是这些值中的一个。

返回

无。

SetQuadPoints()

void foxit::pdf::annots::Redact::SetQuadPoints

(

const QuadPointsArray &

quad_points_array

)

设置四边形。

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

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

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

参数

[in]

quad_points_array

有效的四边形数组。它不应该是空数组。

返回

无。