Foxit PDF SDK
foxit.common.PathArray Class Reference

Inherits SystemIDisposable.

Public Member Functions

 PathArray ()
 Constructor.

 
 PathArray (PathArray other)
 Constructor, with another array object.
More...
 
void Add (Path element)
 Add an element to the end of current array.
More...
 
Path GetAt (uint index)
 Retrieve a copy of the element at position specified by index in current array.
More...
 
uint GetSize ()
 Get the size of elements in current array.
More...
 
void InsertAt (uint index, Path element)
 Insert an element before the position specified by index.
More...
 
void RemoveAll ()
 Remove all the element from current array.
More...
 
void RemoveAt (uint index)
 Remove the element in position specified by index.
More...
 

Detailed Description

This class represents an array of Path objects.

Constructor & Destructor Documentation

◆ PathArray()

foxit.common.PathArray.PathArray ( PathArray  other)
inline

Constructor, with another array object.

Parameters
[in]otherAnother array object.

Member Function Documentation

◆ Add()

void foxit.common.PathArray.Add ( Path  element)
inline

Add an element to the end of current array.

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

◆ GetAt()

Path foxit.common.PathArray.GetAt ( uint  index)
inline

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

uint foxit.common.PathArray.GetSize ( )
inline

Get the size of elements in current array.

Returns
The size.

◆ InsertAt()

void foxit.common.PathArray.InsertAt ( uint  index,
Path  element 
)
inline

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

void foxit.common.PathArray.RemoveAll ( )
inline

Remove all the element from current array.

Returns
None.

◆ RemoveAt()

void foxit.common.PathArray.RemoveAt ( uint  index)
inline

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.