Foxit PDF SDK
fsdk.PDFObject类 参考

Public 成员函数

def CloneObject ()
 克隆当前PDF对象并获取克隆的PDF对象。 更多...
 
def DeepCloneObject ()
 克隆当前PDF对象并获取克隆的PDF对象。 更多...
 
def GetArray ()
 获取当前PDF对象的PDF数组对象。 更多...
 
def GetBoolean ()
 获取当前PDF对象的布尔值。 更多...
 
def GetDateTime ()
 获取当前PDF对象的日期时间值。 更多...
 
def GetDict ()
 获取当前PDF对象的PDF字典对象。 更多...
 
def GetDirectObject ()
 获取当前PDF对象的直接对象。 更多...
 
def GetFloat ()
 获取当前PDF对象的浮点数值。 更多...
 
def GetInteger ()
 获取当前PDF对象的整数值。 更多...
 
def GetMatrix ()
 获取当前PDF对象的矩阵值。 更多...
 
def GetName ()
 获取当前PDF对象的名称值。 更多...
 
def GetObjNum ()
 获取当前PDF对象的间接对象编号。 更多...
 
def GetRect ()
 获取当前PDF对象的矩形值。 更多...
 
def GetStream ()
 获取当前PDF对象的PDF流对象。 更多...
 
def GetString ()
 获取当前PDF对象的字符串值。 更多...
 
def GetType ()
 获取当前PDF对象的类型。 更多...
 
def GetWideString ()
 获取当前PDF对象的宽字符串值。 更多...
 
def IsIdentical (pdf_obj)
 检查输入的PDF对象是否与当前PDF对象相同。 更多...
 
def Release ()
 释放新创建的PDF对象或克隆PDF对象, 该对象与PDF文档或其他PDF对象无关且不会再使用。 更多...
 

详细描述

PDF支持八种基本类型的对象:
“布尔值”、“整数和实数”、“字符串”、“名称”、 “数组”、“字典”、“流”、“空对象”。有关PDF对象的更多详细信息, 请参考<PDF Reference 1.7>中的第3.2节“对象”。
PDFObject 是所有类型PDF对象的基类。它提供了不同的函数来 创建不同类型的PDF对象。对于“数组”、“字典”和“流”PDF对象,请参考 派生类fsdk.PDFArray fsdk.PDFDictionary PDFStream
如果用户想要将新创建的PDF对象设为间接对象,请调用函数 fsdk.PDFDoc.AddIndirectObject

参见
PDFArray
PDFDictionary
PDFStream
fsdk.PDFDoc

成员函数说明

◆ CloneObject()

def fsdk.PDFObject.CloneObject ( )

克隆当前PDF对象并获取克隆的PDF对象。

如果新对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用, 请调用fsdk.PDFObject.Release 来释放该对象。

返回
一个新的PDFObject 对象作为克隆结果。 如果有任何错误,此函数将返回null

◆ DeepCloneObject()

def fsdk.PDFObject.DeepCloneObject ( )

克隆当前PDF对象并获取克隆的PDF对象。

此函数是完全的直接复制,内部没有任何引用对象, 因此复制的对象可以被复制到另一个文档。 如枟新对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用, 请调用fsdk.PDFObject.Release 来释放该对象。

返回
一个新的PDFObject 对象作为克隆结果。 如果有任何错误,此函数将返回null

◆ GetArray()

def fsdk.PDFObject.GetArray ( )

获取当前PDF对象的PDF数组对象。

如果当前PDF对象的类型是fsdk.PDFObjectE_Reference , 此函数将检查当前PDF对象的直接PDF对象。

返回
一个PDF数组对象。如果当前PDF对象或直接PDF对象不是PDF数组, 将返回null

◆ GetBoolean()

def fsdk.PDFObject.GetBoolean ( )

获取当前PDF对象的布尔值。

仅当当前PDF对象的类型为fsdk.PDFObjectE_Boolean 时有用。

返回
布尔值。对于其他类型的PDF对象,将返回false

◆ GetDateTime()

def fsdk.PDFObject.GetDateTime ( )

获取当前PDF对象的日期时间值。

仅当当前PDF对象的类型为fsdk.PDFObjectE_String 且其内容为PDF标准日期格式时有用。

返回
日期时间信息。如果有任何错误或当前对象为其他类型, 将返回一个空的日期和时间对象。

◆ GetDict()

def fsdk.PDFObject.GetDict ( )

获取当前PDF对象的PDF字典对象。

如果当前PDF对象的类型是fsdk.PDFObjectE_Reference , 此函数将检查当前PDF对象的直接PDF对象。

返回
一个PDF字典对象。如果当前PDF对象或直接PDF对象不是PDF字典, 将返回null

◆ GetDirectObject()

def fsdk.PDFObject.GetDirectObject ( )

获取当前PDF对象的直接对象。

如果当前PDF对象的类型是fsdk.PDFObjectE_Reference , 将返回直接对象。

返回
直接PDF对象。对于其他类型的PDF对象,此函数将返回当前PDF对象本身。 如果有任何错误,此函数将返回null

◆ GetFloat()

def fsdk.PDFObject.GetFloat ( )

获取当前PDF对象的浮点数值。

仅当当前PDF对象的类型为fsdk.PDFObjectE_Number 时有用。

返回
浮点数值。对于其他类型的PDF对象,将返回0.0f。

◆ GetInteger()

def fsdk.PDFObject.GetInteger ( )

获取当前PDF对象的整数值。

仅当当前PDF对象的类型为fsdk.PDFObjectE_Number 时有用。

返回
整数值。对于其他类型的PDF对象,将返回0。

◆ GetMatrix()

def fsdk.PDFObject.GetMatrix ( )

获取当前PDF对象的矩阵值。

仅对类型为fsdk.PDFObjectE_Array 且 包含6个数字对象作为元素的PDF对象有用。

返回
一个矩阵。如果有任何错误或当前对象为其他类型, 将返回值为[0 0 0 0 0 0]的矩阵。

◆ GetName()

def fsdk.PDFObject.GetName ( )

获取当前PDF对象的名称值。

仅当当前PDF对象的类型为 fsdk.PDFObjectE_Name fsdk.PDFObjectE_String 时有用。

返回
表示该值的字符串。如果有任何错误或当前对象为其他类型, 将返回空字符串。

◆ GetObjNum()

def fsdk.PDFObject.GetObjNum ( )

获取当前PDF对象的间接对象编号。

返回
间接对象编号。它可能是:
  • 0,如果当前PDF对象是直接对象。

  • 大于0,如果当前PDF对象是间接对象。

  • -1表示有任何错误。

◆ GetRect()

def fsdk.PDFObject.GetRect ( )

获取当前PDF对象的矩形值。

仅对类型为fsdk.PDFObjectE_Array 且 包含4个数字对象作为元素的PDF对象有用。

返回
一个矩形。如果有任何错误或当前对象为其他类型, 将返回值为[0 0 0 0]的矩形。

◆ GetStream()

def fsdk.PDFObject.GetStream ( )

获取当前PDF对象的PDF流对象。

如果当前PDF对象的类型是fsdk.PDFObjectE_Reference , 此函数将检查当前PDF对象的直接PDF对象。

返回
一个PDF流对象。如果当前PDF对象或直接PDF对象不是PDF流, 将返回null

◆ GetString()

def fsdk.PDFObject.GetString ( )

获取当前PDF对象的字符串值。

此函数将获取当前PDF对象实际值的字符串格式:

如果当前PDF对象的值无法转换为有效的字符串,将返回空字符串。

返回
一个字符串。

◆ GetType()

def fsdk.PDFObject.GetType ( )

获取当前PDF对象的类型。

返回
PDF对象类型。请参考从fsdk.PDFObjectE_Boolean 开始的值, 此值将是这些值之一。

◆ GetWideString()

def fsdk.PDFObject.GetWideString ( )

获取当前PDF对象的宽字符串值。

此函数将获取当前PDF对象实际值的字符串格式:

如果当前PDF对象的值无法转换为有效的字符串,将返回空字符串。

返回
一个字符串。

◆ IsIdentical()

def fsdk.PDFObject.IsIdentical (   pdf_obj)

检查输入的PDF对象是否与当前PDF对象相同。

参数
[in]pdf_obj另一个PDF对象,将与当前PDF对象进行比较。
返回
true表示输入的PDF对象与当前PDF对象相同, 而false表示输入的PDF对象与当前PDF对象不相同。

◆ Release()

def fsdk.PDFObject.Release ( )

释放新创建的PDF对象或克隆PDF对象, 该对象与PDF文档或其他PDF对象无关且不会再使用。

此函数应仅用于新创建的PDF对象或克隆的PDF对象, 该对象尚未被添加或设置到其他PDF对象或与PDF文档相关联, 且不会再使用。请勿在其他情况下使用此函数, 否则可能会发生未知错误。

返回
无。