Foxit PDF SDK
FSDK.GraphicsObjectArray Class Reference

Public Member Functions

 Add (newElement)
 Add an element at the tail. Potentially growing the array. More...
 
 constructor ()
 Constructor.
 
 Find (data, iStart)
 Find an element from specified position to last. More...
 
 GetAt (nIndex)
 This method retrieves an element specified by an index number. More...
 
 InsertAt (nIndex, newElement, nCount)
 Inset one or more continuous element at specified position. More...
 
 InsertAt (nStartIndex, pNewArray)
 Inset an array at specified position. More...
 
GetSize() RemoveAll ()
 Get the number of elements in the array. More...
 
 RemoveAt (nIndex, nCount)
 Remove a number of elements at specified position. More...
 
 SetAt (nIndex, newElement)
 This method overwrites an element specified by an index number. More...
 
 SetAtGrow (nIndex, newElement)
 Set an element value at specified position. Potentially growing the array. More...
 

Member Function Documentation

◆ Add()

FSDK.GraphicsObjectArray.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()

FSDK.GraphicsObjectArray.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()

FSDK.GraphicsObjectArray.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.

◆ InsertAt() [1/2]

FSDK.GraphicsObjectArray.InsertAt ( nIndex  ,
newElement  ,
nCount   
)

Inset one or more continuous element at specified position.

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

◆ InsertAt() [2/2]

FSDK.GraphicsObjectArray.InsertAt ( nStartIndex  ,
pNewArray   
)

Inset an array at specified position.

Parameters
[in]nStartIndexSpecifies the zero-based index of start element to insert at.
[in]pNewArrayThe input array.
Returns
true means success, while false means failure (such as parameter or memory error).

◆ RemoveAll()

GetSize () FSDK.GraphicsObjectArray.RemoveAll ( )

Get the number of elements in the array.

Returns
The number of elements in the array.

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

Returns
The upper bound.

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).

Clean up the array.

Returns
None.

◆ RemoveAt()

FSDK.GraphicsObjectArray.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()

FSDK.GraphicsObjectArray.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()

FSDK.GraphicsObjectArray.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.