Foxit PDF SDK
fsdk.PDFArray Class Reference

Public Member Functions

def AddBoolean (boolean_value)
 Add a boolean value to the end of current PDF array object.
More...
 
def AddDateTime (date_time)
 Add a date time to the end of current PDF array object.
More...
 
def AddElement (element)
 Add a PDF object to the end of current PDF array object.
More...
 
def AddFloat (float_value)
 Add a float value to the end of current PDF array object.
More...
 
def AddInteger (integer_value)
 Add an integer value to the end of current PDF array object.
More...
 
def AddMatrix (matrix)
 Add a matrix to the end of current PDF array object.
More...
 
def AddName (name)
 Add a string as PDF name object to the end of current PDF array object.
More...
 
def AddRect (rect)
 Add a rectangle to the end of current PDF array object.
More...
 
def AddReference (pdf_object, document)
 Set the reference object of an indirect PDF object (whose object number is always above 0) as value element.
More...
 
def AddString (new_string)
 Add a string as PDF string object to the end of current PDF array object.
More...
 
def GetElement (index)
 Get a specified element by index.
More...
 
def GetElementCount ()
 Get the count of elements.
More...
 
def InsertAt (index, element)
 Insert a PDF object to a specified position in current PDF array object.
More...
 
def RemoveAt (index)
 Remove an element in a specified position (by index) from current PDF array object.
More...
 
def SetAt (index, element)
 Set a new PDF object at a specified position in current PDF array object.
More...
 

Detailed Description

A PDF array object is a one-dimensional collection of objects arranged sequentially. Unlike arrays in many other computer languages, elements in a PDF array can be any combination of numbers, strings, dictionaries, or any other objects, including other arrays. For more details, please refer to Section 3.2.5 "Array Objects" in <PDF Reference 1.7>.
Class fsdk.PDFArray is derived from PDFObject and offers functions to create a new PDF array object and get/set elements of a PDF array object.

See also
PDFObject

Member Function Documentation

◆ AddBoolean()

def fsdk.PDFArray.AddBoolean (   boolean_value)

Add a boolean value to the end of current PDF array object.

Parameters
[in]boolean_valueA boolean value to current PDF array object.
Returns
None.

◆ AddDateTime()

def fsdk.PDFArray.AddDateTime (   date_time)

Add a date time to the end of current PDF array object.

Parameters
[in]date_timeA date time to current PDF array object.
Returns
None.

◆ AddElement()

def fsdk.PDFArray.AddElement (   element)

Add a PDF object to the end of current PDF array object.

Parameters
[in]elementA PDF object to be added to current PDF array object. It should not be null.
Returns
None.

◆ AddFloat()

def fsdk.PDFArray.AddFloat (   float_value)

Add a float value to the end of current PDF array object.

Parameters
[in]float_valueA float value to current PDF array object.
Returns
None.

◆ AddInteger()

def fsdk.PDFArray.AddInteger (   integer_value)

Add an integer value to the end of current PDF array object.

Parameters
[in]integer_valueAn integer value to current PDF array object.
Returns
None.

◆ AddMatrix()

def fsdk.PDFArray.AddMatrix (   matrix)

Add a matrix to the end of current PDF array object.

Parameters
[in]matrixA matrix to current PDF array object.
Returns
None.

◆ AddName()

def fsdk.PDFArray.AddName (   name)

Add a string as PDF name object to the end of current PDF array object.

Parameters
[in]nameA string to be added as PDF name object to current PDF array object. It should not be an empty string.
Returns
None.

◆ AddRect()

def fsdk.PDFArray.AddRect (   rect)

Add a rectangle to the end of current PDF array object.

Parameters
[in]rectA rectangle to current PDF array object.
Returns
None.

◆ AddReference()

def fsdk.PDFArray.AddReference (   pdf_object,
  document 
)

Set the reference object of an indirect PDF object (whose object number is always above 0) as value element.

If user wants to set direct PDF object (whose object number is always equal to 0) to an entry, please refer to function fsdk.PDFDictionary.SetAt .

Parameters
[in]pdf_objectA PDFObject object which is an indirect PDF object (whose object number is always above 0) and will be set to the entry by a reference object which refers to this indirect object. It should not be null.
[in]documentA valid PDF document object, to which current PDF dictionary object belongs and in which parameter pdf_object is or will be an indirect object.
Returns
None.

◆ AddString()

def fsdk.PDFArray.AddString (   new_string)

Add a string as PDF string object to the end of current PDF array object.

Parameters
[in]new_stringA string to be added as PDF string object to current PDF array object. It should not be an empty string.
Returns
None.

◆ GetElement()

def fsdk.PDFArray.GetElement (   index)

Get a specified element by index.

Parameters
[in]indexIndex of the element to be retrieved. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFArray.GetElementCount .
Returns
A PDFObject object that receives the specified element. If there is any error, this function will return null.

◆ GetElementCount()

def fsdk.PDFArray.GetElementCount ( )

Get the count of elements.

Returns
Element count.

◆ InsertAt()

def fsdk.PDFArray.InsertAt (   index,
  element 
)

Insert a PDF object to a specified position in current PDF array object.

Parameters
[in]indexIndex of the position where parameter element will be inserted to. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFArray.GetElementCount .
If this is below 0 or count of elements in current PDF array is 0, parameter element is to be inserted to the first position.
If this is larger than count of element in current PDF array, parameter element is to be added to the end.
[in]elementA PDF object to be inserted to current PDF array object. It should not be null.
Returns
None.

◆ RemoveAt()

def fsdk.PDFArray.RemoveAt (   index)

Remove an element in a specified position (by index) from current PDF array object.

Parameters
[in]indexIndex of the position where the element will be removed. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFArray.GetElementCount .
Returns
None.

◆ SetAt()

def fsdk.PDFArray.SetAt (   index,
  element 
)

Set a new PDF object at a specified position in current PDF array object.

Parameters
[in]indexIndex of the position where parameter element will be set to. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFArray.GetElementCount .
[in]elementA PDF object to be set to current PDF array object. It should not be null.
Returns
None.