Foxit PDF SDK
foxit.pdf.objects.PDFArray类 参考
类 foxit.pdf.objects.PDFArray 继承关系图:
foxit.pdf.objects.PDFObject

Public 成员函数

void AddBoolean (bool boolean_value)
 将布尔值添加到当前PDF数组对象的末尾。 更多...
 
void AddDateTime (DateTime date_time)
 将日期时间添加到当前PDF数组对象的末尾。 更多...
 
void AddElement (PDFObject element)
 将PDF对象添加到当前PDF数组对象的末尾。 更多...
 
void AddFloat (float float_value)
 将浮点数值添加到当前PDF数组对象的末尾。 更多...
 
void AddInteger (int integer_value)
 将整数值添加到当前PDF数组对象的末尾。 更多...
 
void AddMatrix (Matrix2D matrix)
 将矩阵添加到当前PDF数组对象的末尾。 更多...
 
void AddName (string name)
 将字符串作为PDF名称对象添加到当前PDF数组对象的末尾。 更多...
 
void AddRect (RectF rect)
 将矩形添加到当前PDF数组对象的末尾。 更多...
 
void AddReference (PDFObject pdf_object, PDFDoc document)
 将间接PDF对象(其对象编号总是大于0)的引用对象设置为值元素。 更多...
 
void AddString (string new_string)
 将字符串作为PDF字符串对象添加到当前PDF数组对象的末尾。 更多...
 
PDFObject GetElement (int index)
 通过索引获取指定的元素。 更多...
 
int GetElementCount ()
 获取元素的数量。 更多...
 
void InsertAt (int index, PDFObject element)
 将PDF对象插入到当前PDF数组对象的指定位置。 更多...
 
void RemoveAt (int index)
 从当前PDF数组对象中移除指定位置(按索引)的元素。 更多...
 
void SetAt (int index, PDFObject element)
 在当前PDF数组对象的指定位置设置新的PDF对象。 更多...
 
- Public 成员函数 继承自 foxit.pdf.objects.PDFObject
PDFObject CloneObject ()
 克隆当前PDF对象并获取克隆的PDF对象。 更多...
 
PDFObject DeepCloneObject ()
 克隆当前PDF对象并获取克隆的PDF对象。 更多...
 
PDFArray GetArray ()
 获取当前PDF对象的PDF数组对象。 更多...
 
bool GetBoolean ()
 获取当前PDF对象的布尔值。 更多...
 
DateTime GetDateTime ()
 获取当前PDF对象的日期时间值。 更多...
 
PDFDictionary GetDict ()
 获取当前PDF对象的PDF字典对象。 更多...
 
PDFObject GetDirectObject ()
 获取当前PDF对象的直接对象。 更多...
 
float GetFloat ()
 获取当前PDF对象的浮点数值。 更多...
 
int GetInteger ()
 获取当前PDF对象的整数值。 更多...
 
Matrix2D GetMatrix ()
 获取当前PDF对象的矩阵值。 更多...
 
string GetName ()
 获取当前PDF对象的名称值。 更多...
 
int GetObjNum ()
 获取当前PDF对象的间接对象编号。 更多...
 
RectF GetRect ()
 获取当前PDF对象的矩形值。 更多...
 
PDFStream GetStream ()
 获取当前PDF对象的PDF流对象。 更多...
 
byte [] GetString ()
 获取当前PDF对象的字符串值。 更多...
 
PDFObject.Type GetType ()
 获取当前PDF对象的类型。 更多...
 
string GetWideString ()
 获取当前PDF对象的宽字符串值。 更多...
 
bool IsIdentical (PDFObject pdf_obj)
 检查输入的PDF对象是否与当前PDF对象相同。 更多...
 
void Release ()
 释放新创建的PDF对象或克隆PDF对象, 该对象与PDF文档或其他PDF对象无关且不会再使用。 更多...
 

静态 Public 成员函数

static PDFArray Create ()
 创建新的数组对象。 更多...
 
static PDFArray CreateFromMatrix (Matrix2D matrix)
 为矩阵创建新的数组对象。 更多...
 
static PDFArray CreateFromRect (RectF rect)
 为矩形创建新的数组对象。 更多...
 
- 静态 Public 成员函数 继承自 foxit.pdf.objects.PDFObject
static PDFObject CreateFromBoolean (bool boolean_value)
 从布尔值创建PDF对象。 更多...
 
static PDFObject CreateFromDateTime (DateTime date_time)
 从日期时间创建PDF对象。 更多...
 
static PDFObject CreateFromFloat (float float_value)
 从浮点数创建PDF对象。 更多...
 
static PDFObject CreateFromInteger (int integer_value)
 Create a PDF object from a integer number. 更多...
 
static PDFObject CreateFromName (string name)
 从表示名称的字符串创建PDF对象。 更多...
 
static PDFObject CreateFromNameW (string name)
 从表示名称的字符串创建PDF对象。 更多...
 
static PDFObject CreateFromString (string string_value)
 从字符串创建PDF对象。 更多...
 
static PDFObject CreateFromString (string string_value, int length)
 从字符串创建PDF对象。 更多...
 
static PDFObject CreateReference (PDFDoc document, int object_number)
 为间接对象创建引用。 更多...
 

额外继承的成员函数

- Public 类型 继承自 foxit.pdf.objects.PDFObject
enum  Type {
  Type.e_InvalidType = 0, Type.e_Boolean = 1, Type.e_Number = 2, Type.e_String = 3,
  Type.e_Name = 4, Type.e_Array = 5, Type.e_Dictionary = 6, Type.e_Stream = 7,
  Type.e_Null = 8, Type.e_Reference = 9
}
 PDF对象类型的枚举。 更多...
 

详细描述

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

参见
PDFObject

成员函数说明

◆ AddBoolean()

void foxit.pdf.objects.PDFArray.AddBoolean ( bool  boolean_value)
inline

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

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

◆ AddDateTime()

void foxit.pdf.objects.PDFArray.AddDateTime ( DateTime  date_time)
inline

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

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

◆ AddElement()

void foxit.pdf.objects.PDFArray.AddElement ( PDFObject  element)
inline

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

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

◆ AddFloat()

void foxit.pdf.objects.PDFArray.AddFloat ( float  float_value)
inline

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

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

◆ AddInteger()

void foxit.pdf.objects.PDFArray.AddInteger ( int  integer_value)
inline

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

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

◆ AddMatrix()

void foxit.pdf.objects.PDFArray.AddMatrix ( Matrix2D  matrix)
inline

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

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

◆ AddName()

void foxit.pdf.objects.PDFArray.AddName ( string  name)
inline

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

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

◆ AddRect()

void foxit.pdf.objects.PDFArray.AddRect ( RectF  rect)
inline

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

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

◆ AddReference()

void foxit.pdf.objects.PDFArray.AddReference ( PDFObject  pdf_object,
PDFDoc  document 
)
inline

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

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

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

◆ AddString()

void foxit.pdf.objects.PDFArray.AddString ( string  new_string)
inline

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

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

◆ Create()

static PDFArray foxit.pdf.objects.PDFArray.Create ( )
inlinestatic

创建新的数组对象。

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

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

◆ CreateFromMatrix()

static PDFArray foxit.pdf.objects.PDFArray.CreateFromMatrix ( Matrix2D  matrix)
inlinestatic

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

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

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

◆ CreateFromRect()

static PDFArray foxit.pdf.objects.PDFArray.CreateFromRect ( RectF  rect)
inlinestatic

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

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

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

◆ GetElement()

PDFObject foxit.pdf.objects.PDFArray.GetElement ( int  index)
inline

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

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

◆ GetElementCount()

int foxit.pdf.objects.PDFArray.GetElementCount ( )
inline

获取元素的数量。

返回
元素数量。

◆ InsertAt()

void foxit.pdf.objects.PDFArray.InsertAt ( int  index,
PDFObject  element 
)
inline

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

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

◆ RemoveAt()

void foxit.pdf.objects.PDFArray.RemoveAt ( int  index)
inline

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

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

◆ SetAt()

void foxit.pdf.objects.PDFArray.SetAt ( int  index,
PDFObject  element 
)
inline

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

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