Foxit PDF SDK
foxit.common.StringArray Class Reference

Inherits SystemIDisposable.

Public Member Functions

 StringArray ()
 Constructor.

 
 StringArray (StringArray other)
 Constructor, with another array object.
More...
 
void Add (string element)
 Add an element to the end of current array.
More...
 
void AddBytes (byte[] bytes_string)
 Constructor, with another object.
More...
 
string GetAt (uint index)
 Retrieve a copy of the element at position specified by index in current array.
More...
 
byte [] GetBytesAt (uint index)
 GetBytesAt, with another object.
More...
 
uint GetSize ()
 Get the size of elements in current array.
More...
 
void InsertAt (uint index, string element)
 Insert an element before the position specified by index.
More...
 
void InsertBytesAt (uint index, byte[] bytes_string)
 Constructor, with another object.
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 String objects.

Constructor & Destructor Documentation

◆ StringArray()

foxit.common.StringArray.StringArray ( StringArray  other)
inline

Constructor, with another array object.

Parameters
[in]otherAnother array object.

Member Function Documentation

◆ Add()

void foxit.common.StringArray.Add ( string  element)
inline

Add an element to the end of current array.

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

◆ AddBytes()

void foxit.common.StringArray.AddBytes ( byte []  bytes_string)
inline

Constructor, with another object.

Parameters
[in]bytes_stringNew byte array element to be added to current array.

◆ GetAt()

string foxit.common.StringArray.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.

◆ GetBytesAt()

byte[] foxit.common.StringArray.GetBytesAt ( uint  index)
inline

GetBytesAt, with another object.

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

◆ GetSize()

uint foxit.common.StringArray.GetSize ( )
inline

Get the size of elements in current array.

Returns
The size.

◆ InsertAt()

void foxit.common.StringArray.InsertAt ( uint  index,
string  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.

◆ InsertBytesAt()

void foxit.common.StringArray.InsertBytesAt ( uint  index,
byte []  bytes_string 
)
inline

Constructor, with another object.

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]bytes_stringNew byte array element to be inserted to current array.

◆ RemoveAll()

void foxit.common.StringArray.RemoveAll ( )
inline

Remove all the element from current array.

Returns
None.

◆ RemoveAt()

void foxit.common.StringArray.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.