Foxit PDF SDK
fsdk.PDFArray类 参考

Public 成员函数

def AddBoolean (boolean_value)
 将布尔值添加到当前PDF数组对象的末尾。 更多...
 
def AddDateTime (date_time)
 将日期时间添加到当前PDF数组对象的末尾。 更多...
 
def AddElement (element)
 将PDF对象添加到当前PDF数组对象的末尾。 更多...
 
def AddFloat (float_value)
 将浮点数值添加到当前PDF数组对象的末尾。 更多...
 
def AddInteger (integer_value)
 将整数值添加到当前PDF数组对象的末尾。 更多...
 
def AddMatrix (matrix)
 将矩阵添加到当前PDF数组对象的末尾。 更多...
 
def AddName (name)
 将字符串作为PDF名称对象添加到当前PDF数组对象的末尾。 更多...
 
def AddRect (rect)
 将矩形添加到当前PDF数组对象的末尾。 更多...
 
def AddReference (pdf_object, document)
 将间接PDF对象(其对象编号总是大于0)的引用对象设置为值元素。 更多...
 
def AddString (new_string)
 将字符串作为PDF字符串对象添加到当前PDF数组对象的末尾。 更多...
 
def GetElement (index)
 通过索引获取指定的元素。 更多...
 
def GetElementCount ()
 获取元素的数量。 更多...
 
def InsertAt (index, element)
 将PDF对象插入到当前PDF数组对象的指定位置。 更多...
 
def RemoveAt (index)
 从当前PDF数组对象中移除指定位置(按索引)的元素。 更多...
 
def SetAt (index, element)
 在当前PDF数组对象的指定位置设置新的PDF对象。 更多...
 

详细描述

PDF数组对象是按顺序排列的对象的一维集合。 与许多其他计算机语言中的数组不同,PDF数组中的元素可以是数字、 字符串、字典或任何其他对象(包括其他数组)的任意组合。 有关更多详细信息,请参阅<PDF Reference 1.7>中的第3.2.5节“数组对象”。
fsdk.PDFArray 派生自PDFObject ,并提供函数来创建新的PDF数组对象以及 获取/设置PDF数组对象的元素。

参见
PDFObject

成员函数说明

◆ AddBoolean()

def fsdk.PDFArray.AddBoolean (   boolean_value)

将布尔值添加到当前PDF数组对象的末尾。

参数
[in]boolean_value要添加到当前PDF数组对象的布尔值。
返回
无。

◆ AddDateTime()

def fsdk.PDFArray.AddDateTime (   date_time)

将日期时间添加到当前PDF数组对象的末尾。

参数
[in]date_time要添加到当前PDF数组对象的日期时间。
返回
无。

◆ AddElement()

def fsdk.PDFArray.AddElement (   element)

将PDF对象添加到当前PDF数组对象的末尾。

参数
[in]element要添加到当前PDF数组对象的PDF对象。它不应为null
返回
无。

◆ AddFloat()

def fsdk.PDFArray.AddFloat (   float_value)

将浮点数值添加到当前PDF数组对象的末尾。

参数
[in]float_value要添加到当前PDF数组对象的浮点数值。
返回
无。

◆ AddInteger()

def fsdk.PDFArray.AddInteger (   integer_value)

将整数值添加到当前PDF数组对象的末尾。

参数
[in]integer_value要添加到当前PDF数组对象的整数值。
返回
无。

◆ AddMatrix()

def fsdk.PDFArray.AddMatrix (   matrix)

将矩阵添加到当前PDF数组对象的末尾。

参数
[in]matrix要添加到当前PDF数组对象的矩阵。
返回
无。

◆ AddName()

def fsdk.PDFArray.AddName (   name)

将字符串作为PDF名称对象添加到当前PDF数组对象的末尾。

参数
[in]name要作为PDF名称对象添加到当前PDF数组对象的字符串。 它不应为空字符串。
返回
无。

◆ AddRect()

def fsdk.PDFArray.AddRect (   rect)

将矩形添加到当前PDF数组对象的末尾。

参数
[in]rect要添加到当前PDF数组对象的矩形。
返回
无。

◆ AddReference()

def fsdk.PDFArray.AddReference (   pdf_object,
  document 
)

将间接PDF对象(其对象编号总是大于0)的引用对象设置为值元素。

如果用户想要将直接PDF对象(其对象编号总是等于0)设置到条目, 请参考函数fsdk.PDFDictionary.SetAt

参数
[in]pdf_object一个PDFObject 对象,它是一个间接PDF对象(其对象编号总是大于0), 将通过引用此间接对象的引用对象设置到条目。它不应为null
[in]document一个有效的PDF文档对象,当前PDF字典对象属于该文档, 且参数pdf_object是或将是其中的间接对象。
返回
无。

◆ AddString()

def fsdk.PDFArray.AddString (   new_string)

将字符串作为PDF字符串对象添加到当前PDF数组对象的末尾。

参数
[in]new_string要作为PDF字符串对象添加到当前PDF数组对象的字符串。 它不应为空字符串。
返回
无。

◆ GetElement()

def fsdk.PDFArray.GetElement (   index)

通过索引获取指定的元素。

参数
[in]index要检索的元素的索引。有效范围:从0到(count-1)。 count由函数fsdk.PDFArray.GetElementCount 返回。
返回
一个PDFObject 对象,接收指定的元素。 如果有任何错误,此函数将返回null

◆ GetElementCount()

def fsdk.PDFArray.GetElementCount ( )

获取元素的数量。

返回
元素数量。

◆ InsertAt()

def fsdk.PDFArray.InsertAt (   index,
  element 
)

将PDF对象插入到当前PDF数组对象的指定位置。

参数
[in]index参数element将被插入到的位置的索引。 有效范围:从0到(count-1)。 count由函数fsdk.PDFArray.GetElementCount 返回。
如果小于0或当前PDF数组中的元素数量为0, 参数element将被插入到第一个位置。
如果大于当前PDF数组中的元素数量, 参数element将被添加到末尾。
[in]element要插入到当前PDF数组对象的PDF对象。它不应为null
返回
无。

◆ RemoveAt()

def fsdk.PDFArray.RemoveAt (   index)

从当前PDF数组对象中移除指定位置(按索引)的元素。

参数
[in]index将被移除的元素的位置的索引。 有效范围:从0到(count-1)。 count由函数fsdk.PDFArray.GetElementCount 返回。
返回
无。

◆ SetAt()

def fsdk.PDFArray.SetAt (   index,
  element 
)

在当前PDF数组对象的指定位置设置新的PDF对象。

参数
[in]index参数element将被设置到的位置的索引。 有效范围:从0到(count-1)。 count由函数fsdk.PDFArray.GetElementCount 返回。
[in]element要设置到当前PDF数组对象的PDF对象。它不应为null
返回
无。