Foxit::PDFPath Class Reference

Class to represent a PDF path. More...

Public Member Functions

Boolean Release ()
 Release resources of current PDF path object. More...
 
void Clear ()
 Clear all path points. More...
 
Int32 CountPathPoints ()
 Count path points. More...
 
PathPointGetPathPoint (Int32 index)
 Get a path point by index. More...
 
Boolean AddPathPoint (PathPoint^ pathPoint)
 Add a path point to the end. More...
 
Boolean RemovePathPoint (Int32 index)
 Remove a path point by index. More...
 

Static Public Member Functions

static PDFPathCreate ()
 Create a new PDF path object. More...
 

Properties

Int64 pointer
 Pointer to a handle of PDF path object. This pointer is not useful outside this SDK. The application should not access the pointer to the handle of the PDF path object directly.
 

Detailed Description

Class to represent a PDF path.

Member Function Documentation

Boolean Foxit::PDFPath::AddPathPoint ( PathPoint pathPoint)

Add a path point to the end.

Parameters
[in]pathPointA Foxit::PathPoint object that specifies the path point to be added to the end of current path. Please check comment of class Foxit::PathPoint to ensure pass a valid Foxit::PathPoint object.
Returns
true for success, while false for failure.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param means parameter pathPoint is nullptr or invalid.
For more error code values, please refer to enumeration Foxit::ErrorCode.
void Foxit::PDFPath::Clear ( )

Clear all path points.

Returns
None.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
For more error code values, please refer to enumeration Foxit::ErrorCode.
Int32 Foxit::PDFPath::CountPathPoints ( )

Count path points.

Returns
The count of path points.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.
static PDFPath ^ Foxit::PDFPath::Create ( )
static

Create a new PDF path object.

Returns
A Foxit::PDFPath object that receives the new PDF path object, not containing any path point yet. If there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
For more error code values, please refer to enumeration Foxit::ErrorCode.
PathPoint ^ Foxit::PDFPath::GetPathPoint ( Int32  index)

Get a path point by index.

Parameters
[in]indexThe index of path point object to be got. Range: 0 to (pathpointcount-1). pathpointcount is returned by function PDFPath::CountPathPoints.
Returns
A Foxit::PathPoint object that receives the specific path point object. If there is any error, this function will return nullptr.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means parameter index is out of the range.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.
Boolean Foxit::PDFPath::Release ( )

Release resources of current PDF path object.

Returns
true for success, while false for failure.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
For more error code values, please refer to enumeration Foxit::ErrorCode.
Boolean Foxit::PDFPath::RemovePathPoint ( Int32  index)

Remove a path point by index.

Parameters
[in]indexThe index of path point object to be got. Range: 0 to (pathpointcount-1). pathpointcount is returned by function PDFPath::CountPathPoints.
Returns
true for success, while false for failure.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::NotFound means parameter index is out of the range.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Foxit Corporation