Foxit PDF SDK
fsdk.Redact类 参考

Public 成员函数

def Apply ()
 应用当前编辑注释:永久移除注释矩形下的文本、图形和注释。 更多...
 
def EnableAutoFontSize ()
 为覆盖文本启用自动字体大小。 更多...
 
def EnableRepeatOverlayText (is_to_repeat_overlay_text)
 设置标志以决定是否重复覆盖文本。 更多...
 
def GetApplyFillColor ()
 获取用于翻转外观的填充颜色,将在应用编辑后使用。 更多...
 
def GetDefaultAppearance ()
 获取默认外观数据。 更多...
 
def GetFillColor ()
 获取填充颜色。 更多...
 
def GetOverlayText ()
 获取覆盖文本。 更多...
 
def GetOverlayTextAlignment ()
 获取覆盖文本的对齐值。 更多...
 
def GetQuadPoints ()
 获取四边形。 更多...
 
def IsOverlayTextRepeated ()
 检查覆盖文本是否重复。 更多...
 
def SetApplyFillColor (fill_color)
 设置用于翻转外观的填充颜色,将在应用编辑后使用。 更多...
 
def SetDefaultAppearance (default_ap)
 设置默认外观数据。 更多...
 
def SetFillColor (fill_color)
 设置填充颜色。 更多...
 
def SetOverlayText (overlay_text)
 设置覆盖文本。 更多...
 
def SetOverlayTextAlignment (alignment)
 设置覆盖文本的对齐值。 更多...
 
def SetQuadPoints (quad_points_array)
 设置四边形。 更多...
 

详细描述

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

参见
fsdk.Redaction
fsdk.PDFPage
Markup

成员函数说明

◆ Apply()

def fsdk.Redact.Apply ( )

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

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

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

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

◆ EnableAutoFontSize()

def fsdk.Redact.EnableAutoFontSize ( )

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

返回
无。

◆ EnableRepeatOverlayText()

def fsdk.Redact.EnableRepeatOverlayText (   is_to_repeat_overlay_text)

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

参数
[in]is_to_repeat_overlay_texttrue表示重复覆盖文本,而false表示不重复。 默认值:false
返回
无。

◆ GetApplyFillColor()

def fsdk.Redact.GetApplyFillColor ( )

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

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

◆ GetDefaultAppearance()

def fsdk.Redact.GetDefaultAppearance ( )

获取默认外观数据。

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

返回
默认外观数据。

◆ GetFillColor()

def fsdk.Redact.GetFillColor ( )

获取填充颜色。

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

◆ GetOverlayText()

def fsdk.Redact.GetOverlayText ( )

获取覆盖文本。

返回
覆盖文本字符串。

◆ GetOverlayTextAlignment()

def fsdk.Redact.GetOverlayTextAlignment ( )

获取覆盖文本的对齐值。

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

返回
对齐值。请参考从fsdk.E_AlignmentLeft 开始的值, 这将是这些值中的一个。

◆ GetQuadPoints()

def fsdk.Redact.GetQuadPoints ( )

获取四边形。

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

  • 第一个点是四边形左上角的点。

  • 第二个点是四边形右上角的点。

  • 第三个点是四边形左下角的点。

  • 第四个点是四边形右下角的点。

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

◆ IsOverlayTextRepeated()

def fsdk.Redact.IsOverlayTextRepeated ( )

检查覆盖文本是否重复。

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

◆ SetApplyFillColor()

def fsdk.Redact.SetApplyFillColor (   fill_color)

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

参数
[in]fill_color要设置的新填充颜色。格式:0xRRGGBB。
返回
无。

◆ SetDefaultAppearance()

def fsdk.Redact.SetDefaultAppearance (   default_ap)

设置默认外观数据。

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

参数
[in]default_ap要设置的新默认外观数据。 输入数据的flags可用于决定哪些信息将 使用新数据更新;对于那些未更新的数据,它们将继续使用旧数据。
返回
true表示成功,而false表示失败。 特别地,如果参数default_ap包含任何不正确的值,此函数将返回false, 例如:

◆ SetFillColor()

def fsdk.Redact.SetFillColor (   fill_color)

设置填充颜色。

参数
[in]fill_color要设置的新填充颜色。格式:0xRRGGBB。
返回
无。

◆ SetOverlayText()

def fsdk.Redact.SetOverlayText (   overlay_text)

设置覆盖文本。

参数
[in]overlay_text要设置的覆盖文本字符串。
返回
无。

◆ SetOverlayTextAlignment()

def fsdk.Redact.SetOverlayTextAlignment (   alignment)

设置覆盖文本的对齐值。

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

参数
[in]alignment新的对齐值。请参考从fsdk.E_AlignmentLeft 开始的值, 这应该是这些值中的一个。
返回
无。

◆ SetQuadPoints()

def fsdk.Redact.SetQuadPoints (   quad_points_array)

设置四边形。

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

  • 第一个点是四边形左上角的点。

  • 第二个点是四边形右上角的点。

  • 第三个点是四边形左下角的点。

  • 第四个点是四边形右下角的点。

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

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