Foxit PDF SDK
FSDK::PDFArray类 参考

Public 成员函数

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

静态 Public 成员函数

static Create ()
 创建新的数组对象。 更多...
 
static CreateFromMatrix (matrix)
 为矩阵创建新的数组对象。 更多...
 
static CreateFromRect (rect)
 为矩形创建新的数组对象。 更多...
 

详细描述

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

参见
FSDK.PDFObject

成员函数说明

◆ AddBoolean()

FSDK::PDFArray::AddBoolean ( boolean_value  )

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

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

◆ AddDateTime()

FSDK::PDFArray::AddDateTime ( date_time  )

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

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

◆ AddElement()

FSDK::PDFArray::AddElement ( element  )

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

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

◆ AddFloat()

FSDK::PDFArray::AddFloat ( float_value  )

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

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

◆ AddInteger()

FSDK::PDFArray::AddInteger ( integer_value  )

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

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

◆ AddMatrix()

FSDK::PDFArray::AddMatrix ( matrix  )

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

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

◆ AddName()

FSDK::PDFArray::AddName ( name  )

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

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

◆ AddRect()

FSDK::PDFArray::AddRect ( rect  )

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

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

◆ AddReference()

FSDK::PDFArray::AddReference ( pdf_object  ,
document   
)

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

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

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

◆ AddString()

FSDK::PDFArray::AddString ( new_string  )

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

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

◆ Create()

static FSDK::PDFArray::Create ( )
static

创建新的数组对象。

如果创建的对象尚未被添加/设置到PDF文档或其他PDF对象中,且将不再使用, 请调用函数 FSDK.PDFObject.Release 来释放创建的对象。

返回
新的 FSDK.PDFArray 对象。 如果有任何错误,此函数将返回 null

◆ CreateFromMatrix()

static FSDK::PDFArray::CreateFromMatrix ( matrix  )
static

为矩阵创建新的数组对象。

如果创建的对象尚未被添加/设置到PDF文档或其他PDF对象中,且将不再使用, 请调用函数 FSDK.PDFObject.Release 来释放创建的对象。

参数
[in]matrix矩阵。
返回
新的 FSDK.PDFArray 对象。 如果有任何错误,此函数将返回 null

◆ CreateFromRect()

static FSDK::PDFArray::CreateFromRect ( rect  )
static

为矩形创建新的数组对象。

如果创建的对象尚未被添加/设置到PDF文档或其他PDF对象中,且将不再使用, 请调用函数 FSDK.PDFObject.Release 来释放创建的对象。

参数
[in]rect矩形。
返回
新的 FSDK.PDFArray 对象。 如果有任何错误,此函数将返回 null

◆ GetElement()

FSDK::PDFArray::GetElement ( index  )

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

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

◆ GetElementCount()

FSDK::PDFArray::GetElementCount ( )

获取元素数量。

返回
元素数量。

◆ InsertAt()

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
返回
None.

◆ RemoveAt()

FSDK::PDFArray::RemoveAt ( index  )

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

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

◆ SetAt()

FSDK::PDFArray::SetAt ( index  ,
element   
)

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

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