Foxit::PDF::EmbeddedGotoActionTarget Class Reference

Class to represent the target data of embedded go-to action. More...

Public Member Functions

 EmbeddedGotoActionTarget ()
 Default constructor.
 
 EmbeddedGotoActionTarget (String^ relationship, String^ filename, String^ destname, String^ annotname, int32 pageindex, int32 annotindex)
 Constructor to initialize a new instance of class PDF::EmbeddedGotoActionTarget with specific values.
 
Boolean Release ()
 Release all the data. More...
 
EmbeddedGotoActionTargetGetNext ()
 Get the next target object. More...
 
void SetNext (EmbeddedGotoActionTarget^ next)
 Set next target object. More...
 

Properties

String^  Relationship
 Relationship between current document and the target document. Valid values are "P"(the target is the parent of the current document) and "C"(the target is a child of the current document).
 
String^  FileName
 Name of the file in the EmbeddedFiles name tree. More...
 
String^  DestName
 A named destination in target document that provides the page index of the file attachment annotation. More...
 
String^  AnnotName
 Value of NM in the annotation dictionary. More...
 
int32 PageIndex
 Page index(zero-based) in target document containing the file attachment annotation. More...
 
int32 AnnotIndex
 Annotation index(zero-based) in the page. More...
 
int64 pointer
 Pointer to a handle of embedded goto action target object. This pointer is not useful outside this SDK. The application should not access the pointer to the handle of the embedded goto action target object directly.
 

Detailed Description

Class to represent the target data of embedded go-to action.

Member Function Documentation

EmbeddedGotoActionTarget ^ Foxit::PDF::EmbeddedGotoActionTarget::GetNext ( )

Get the next target object.

Returns
A PDF::EmbeddedGotoActionTarget object that receives the next target data.
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.
Boolean Foxit::PDF::EmbeddedGotoActionTarget::Release ( )

Release all the data.

Returns
A boolean value: true means success, while false means error.
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.
void Foxit::PDF::EmbeddedGotoActionTarget::SetNext ( EmbeddedGotoActionTarget next)

Set next target object.

Parameters
[in]nextA PDF::EmbeddedGotoActionTarget object to be set in current target object.
Returns
None.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param means parameter next is invalid.
ErrorCode::OutOfMemory means there is no enough memory or the memory access is wrong.
ErrorCode::Error means the function fails because of any other reasons.

Property Documentation

int32 Foxit::PDF::EmbeddedGotoActionTarget::AnnotIndex

Annotation index(zero-based) in the page.

If this is -1, EmbeddedGotoActionTarget::AnnotName should be used.

String^ Foxit::PDF::EmbeddedGotoActionTarget::AnnotName

Value of NM in the annotation dictionary.

If EmbeddedGotoActionTarget::AnnotIndex is -1, this should be used.

String^ Foxit::PDF::EmbeddedGotoActionTarget::DestName

A named destination in target document that provides the page index of the file attachment annotation.

If EmbeddedGotoActionTarget::PageIndex is -1, this should be used.

String^ Foxit::PDF::EmbeddedGotoActionTarget::FileName

Name of the file in the EmbeddedFiles name tree.

Please refer to section 3.6.3 in PDF Reference 1.7.

int32 Foxit::PDF::EmbeddedGotoActionTarget::PageIndex

Page index(zero-based) in target document containing the file attachment annotation.

If this is -1, EmbeddedGotoActionTarget::DestName should be used.

Foxit Corporation