Foxit PDF SDK
fsdk.SignatureArray Class Reference

Public Member Functions

def Add (element)
 Add an element to the end of current array. More...
 
def GetAt (index)
 Retrieve a copy of the element at position specified by index in current array. More...
 
def GetSize ()
 Get the size of elements in current array. More...
 
def InsertAt (index, element)
 Insert an element before the position specified by index. More...
 
def RemoveAll ()
 Remove all the element from current array. More...
 
def RemoveAt (index)
 Remove the element in position specified by index. More...
 

Detailed Description

This class represents an array of signature objects.

Member Function Documentation

◆ Add()

def fsdk.SignatureArray.Add (   element)

Add an element to the end of current array.

Parameters
[in]elementNew element to be added to current array.
Returns
None.

◆ GetAt()

def fsdk.SignatureArray.GetAt (   index)

Retrieve a copy of the element at position specified by index in current array.

Parameters
[in]indexAn index to specify which element is to be retrieved.
Returns
A copy of an element.

◆ GetSize()

def fsdk.SignatureArray.GetSize ( )

Get the size of elements in current array.

Returns
The size.

◆ InsertAt()

def fsdk.SignatureArray.InsertAt (   index,
  element 
)

Insert an element before the position specified by index.

Parameters
[in]indexAn index to specify where to insert the new element. Valid range: from 0 to (size-1). size is the size of elements in current array.
[in]elementNew element to be inserted to current array.
Returns
None.

◆ RemoveAll()

def fsdk.SignatureArray.RemoveAll ( )

Remove all the element from current array.

Returns
None.

◆ RemoveAt()

def fsdk.SignatureArray.RemoveAt (   index)

Remove the element in position specified by index.

Parameters
[in]indexAn index to specify which element is to be removed. Valid range: from 0 to (size-1). size is the size of elements in current array.
Returns
None.