Foxit PDF SDK
fsdk.PDFDictionaryArray Class Reference

Public Member Functions

def Add (newElement)
 Add an element at the tail. Potentially growing the array. More...
 
def Find (data, iStart)
 Find an element from specified position to last. More...
 
def GetAt (nIndex)
 This method retrieves an element specified by an index number. More...
 
def GetSize ()
 Get the number of elements in the array. More...
 
def GetUpperBound ()
 Get the upper bound in the array, actually the maximum valid index. More...
 
def RemoveAll ()
 Clean up the array. More...
 
def RemoveAt (nIndex, nCount)
 Remove a number of elements at specified position. More...
 
def SetAt (nIndex, newElement)
 This method overwrites an element specified by an index number. More...
 
def SetAtGrow (nIndex, newElement)
 Set an element value at specified position. Potentially growing the array. More...
 
def SetSize (nNewSize, nGrowBy)
 Change the allocated size and the grow amount. More...
 

Detailed Description

This class represents an array of fsdk.PDFDictionary objects.

Member Function Documentation

◆ Add()

def fsdk.PDFDictionaryArray.Add (   newElement)

Add an element at the tail. Potentially growing the array.

Parameters
[in]newElementThe input element.
Returns
true means success, while false means failure (such as memory error).

◆ Find()

def fsdk.PDFDictionaryArray.Find (   data,
  iStart 
)

Find an element from specified position to last.

Parameters
[in]dataThe input element.
[in]iStartSpecifies the zero-based index of start element to find.
Returns
An index of the found element. -1 means found none.

◆ GetAt()

def fsdk.PDFDictionaryArray.GetAt (   nIndex)

This method retrieves an element specified by an index number.

Parameters
[in]nIndexSpecifies the zero-based index of the element.
Returns
An element.

◆ GetSize()

def fsdk.PDFDictionaryArray.GetSize ( )

Get the number of elements in the array.

Returns
The number of elements in the array.

◆ GetUpperBound()

def fsdk.PDFDictionaryArray.GetUpperBound ( )

Get the upper bound in the array, actually the maximum valid index.

Returns
The upper bound.

◆ RemoveAll()

def fsdk.PDFDictionaryArray.RemoveAll ( )

Clean up the array.

Returns
None.

◆ RemoveAt()

def fsdk.PDFDictionaryArray.RemoveAt (   nIndex,
  nCount 
)

Remove a number of elements at specified position.

Parameters
[in]nIndexSpecifies the zero-based index in the array.
[in]nCountSpecifies the count of element to remove.
Returns
true means success, while false means failure (such as parameter or memory error).

◆ SetAt()

def fsdk.PDFDictionaryArray.SetAt (   nIndex,
  newElement 
)

This method overwrites an element specified by an index number.

Parameters
[in]nIndexSpecifies the zero-based index of the element.
[in]newElementAn element.
Returns
true means success, while false means failure.

◆ SetAtGrow()

def fsdk.PDFDictionaryArray.SetAtGrow (   nIndex,
  newElement 
)

Set an element value at specified position. Potentially growing the array.

Parameters
[in]nIndexSpecifies the zero-based index of element in the array.
[in]newElementThe input element.
Returns
true means success, while false means failure.

◆ SetSize()

def fsdk.PDFDictionaryArray.SetSize (   nNewSize,
  nGrowBy 
)

Change the allocated size and the grow amount.

Parameters
[in]nNewSizeThe new size in elements expected.
[in]nGrowByThe grow amount in elements expected. This can be -1 for the grow amount unchanged.
Returns
true means success, while false means failure (such as parameter or memory error).