Foxit PDF SDK
fsdk.FileAttachment类 参考

Public 成员函数

def GetFileSpec ()
 获取文件规范。 更多...
 
def GetIconName ()
 获取图标名称。 更多...
 
def SetFileSpec (file_spec)
 设置文件规范,应指定嵌入的文件。 更多...
 
def SetIconName (icon_name)
 设置图标名称。 更多...
 

详细描述

文件附件注释包含对文件的引用,该文件通常嵌入在PDF文件中。
文件附件注释是一种标记注释,所以类FileAttachment 派生自 类Markup ,并且还提供获取/设置文件附件注释属性和 重置文件附件注释外观流的函数。

注解
对于新创建的文件附件注释,如果用户在不设置任何属性的情况下 直接调用函数fsdk.Annot.ResetAppearanceStream ,将使用默认外观:
边框颜色 = 0xFFFF0000(红色),不透明度 = 1.0,图标名称 = "PushPin"。
参见
Markup

成员函数说明

◆ GetFileSpec()

def fsdk.FileAttachment.GetFileSpec ( )

获取文件规范。

返回
文件规范对象。如果返回的文件规范对象的函数fsdk.FileSpec.IsEmpty 的返回值为true,则表示找不到文件规范属性。

◆ GetIconName()

def fsdk.FileAttachment.GetIconName ( )

获取图标名称。

此属性对文件附件注释的外观有影响。文件附件注释有 预定义的标准图标名称:
"Graph"、"PushPin"、"Paperclip"、"Tag"。
空的图标名称字符串意味着当前文件附件注释将被视为"PushPin"。

返回
图标名称字符串。

◆ SetFileSpec()

def fsdk.FileAttachment.SetFileSpec (   file_spec)

设置文件规范,应指定嵌入的文件。

参数
[in]file_spec要设置的有效文件规范对象。
返回
true表示成功,而false表示失败。

◆ SetIconName()

def fsdk.FileAttachment.SetIconName (   icon_name)

设置图标名称。

此属性对文件附件注释的外观有影响。文件附件注释有 预定义的标准图标名称:
"Graph"、"PushPin"、"Paperclip"、"Tag"。
对于新创建的文件附件注释,如果未调用当前函数,图标名称默认为 "PushPin"。
如果用户希望新图标名称对注释的外观产生影响,请在设置新图标名称后 调用函数fsdk.Annot.ResetAppearanceStream

参数
[in]icon_name要设置的新图标名称字符串。
返回
无。