PDFix SDK  6.5.0
Public Member Functions | List of all members
PdfAction Struct Referenceabstract
Pdf Layer

PdfAction class. More...

Public Member Functions

virtual PdfActionType GetSubtype ()=0
 Gets an action's subtype. More...
 
virtual int GetJavaScript (wchar_t *buffer, int len)=0
 Gets the string buffer from the JavaScript action. More...
 
virtual int GetDestFile (wchar_t *buffer, int len)=0
 
virtual PdfViewDestination * GetViewDestination ()=0
 

Detailed Description

PdfAction class.

The PdfAction are tasks that pdf viewer performs when a user clicks on a link or a bookmark.

Member Function Documentation

◆ GetDestFile()

virtual int PdfAction::GetDestFile ( wchar_t *  buffer,
int  len 
)
pure virtual

Gets the string buffer from the action representing external resource. For URI action it's the uniform resource identifier (URI) typically a file that is the destination of a hypertext link. For Launch action it's a file specification of the application that shall be launched or the document that shall beopened or printed. For GoToE action it's a file specification of an external root document of the source.

Parameters
buffer(filled by method) If the buffer is null function returns required length of string
lenLength of a buffer to be filled in.
Returns
Number of characters written into buffer of required length.

◆ GetJavaScript()

virtual int PdfAction::GetJavaScript ( wchar_t *  buffer,
int  len 
)
pure virtual

Gets the string buffer from the JavaScript action.

Parameters
buffer(filled by method) If the buffer is null function returns required length of string
lenLength of a buffer to be filled in.
Returns
Number of characters written into buffer of required length.

◆ GetSubtype()

virtual PdfActionType PdfAction::GetSubtype ( )
pure virtual

Gets an action's subtype.

Returns
The PdfActionType corresponding to the action's subtype.

◆ GetViewDestination()

virtual PdfViewDestination* PdfAction::GetViewDestination ( )
pure virtual

Gets the view destination of the GoTo or GoToR action. The objects can bee represented by an array or a string object

Returns
the view destination.