Foxit PDF SDK
|
Public Member Functions | |
EmbeddedGotoAction (Action action) | |
Constructor, with parent class object. More... | |
Destination | GetDestination () |
Get the destination information which specifies where to jump to in the final target file. More... | |
string | GetDestinationName () |
Get the destination name which is defined in final target PDF file. More... | |
Action.NewWindowFlag | GetNewWindowFlag () |
Get the flag which is used to decide whether to open the destination document in a new window or not. More... | |
FileSpec | GetRootFile () |
Get the file specification of the root file which is the root file for the target. More... | |
EmbeddedGotoTarget | GetTarget () |
Get the target. More... | |
void | SetDestination (Destination destination) |
Set the destination information which specifies where to jump to in the final target file. More... | |
void | SetDestinationName (string dest_name) |
Set the destination name. More... | |
void | SetNewWindowFlag (Action.NewWindowFlag flag) |
Set the flag which is used to decide whether to open the destination document in a new window or not. More... | |
void | SetRootFile (FileSpec file_specification) |
Set the file specification of the root file which is the root file for the target. More... | |
void | SetTarget (EmbeddedGotoTarget target) |
Set the target. More... | |
![]() | |
Action (PDFDoc document, PDFDictionary action_dict) | |
Constructor, with parameters. More... | |
Action (Action action) | |
Constructor, with another action object. More... | |
PDFDictionary | GetDict () |
Get PDF dictionary of current object. More... | |
PDFDoc | GetDocument () |
Get the PDF document, to which current action belongs. More... | |
Action | GetSubAction (int index) |
Get a sub-action by index. More... | |
int | GetSubActionCount () |
Get the count of sub-actions. More... | |
Action.Type | GetType () |
Get action type. More... | |
void | InsertSubAction (int index, Action sub_action) |
Insert a new sub-action to the location specified by index. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
void | RemoveAllSubActions () |
Remove all the sub-actions. More... | |
void | RemoveSubAction (int index) |
Remove a sub-action, specified by index. More... | |
void | SetSubAction (int index, Action sub_action) |
Set a sub-action by index. More... | |
Additional Inherited Members | |
![]() | |
enum | NewWindowFlag { NewWindowFlag.e_NewWindowFlagFalse = 0, NewWindowFlag.e_NewWindowFlagTrue = 1, NewWindowFlag.e_NewWindowFlagNone = 2 } |
Enumeration for new window flag. More... | |
enum | Type { Type.e_TypeUnknown = 0, Type.e_TypeGoto = 1, Type.e_TypeGoToR = 2, Type.e_TypeGoToE = 3, Type.e_TypeLaunch = 4, Type.e_TypeThread = 5, Type.e_TypeURI = 6, Type.e_TypeSound = 7, Type.e_TypeMovie = 8, Type.e_TypeHide = 9, Type.e_TypeNamed = 10, Type.e_TypeSubmitForm = 11, Type.e_TypeResetForm = 12, Type.e_TypeImportData = 13, Type.e_TypeJavaScript = 14, Type.e_TypeSetOCGState = 15, Type.e_TypeRendition = 16, Type.e_TypeTrans = 17, Type.e_TypeGoTo3DView = 18 } |
Enumeration for action type. More... | |
![]() | |
static Action | Create (PDFDoc document, Action.Type action_type) |
Create a new action, for specified action type. More... | |
Embedded go-to action is similar to a remote go-to action but allows jumping to or from a PDF file that is embedded in another PDF file. Class foxit.pdf.actions.EmbeddedGotoTarget is derived from Action and offers functions to get/set embedded go-to action data.
|
inline |
Constructor, with parent class object.
[in] | action | Parent class object. |
|
inline |
Get the destination information which specifies where to jump to in the final target file.
For a embedded go-to action, the destination information can be stored as either a destination object or a destination name:
If it is a destination object, function EmbeddedGotoAction.GetDestination would return a valid destination object.
If it is a destination name, function EmbeddedGotoAction.GetDestinationName would return a valid string, and the destination name would be defined in the final target PDF file.
If the return value of function Destination.IsEmpty for the returned destination object is true and function EmbeddedGotoAction.GetDestinationName returns an empty string, that means the embedded go-to action does not have any destination information.
|
inline |
Get the destination name which is defined in final target PDF file.
For a remote go-to action, the destination information can be stored as either a destination object or a destination name:
If it is a destination object, function EmbeddedGotoAction.GetDestination would return a valid destination object.
If it is a destination name, function EmbeddedGotoAction.GetDestinationName would return a valid string, and the destination name would be defined in the target PDF file.
If the return value of function Destination.IsEmpty for the returned destination object is true and function EmbeddedGotoAction.GetDestinationName returns an empty string, that means the embedded go-to action does not have any destination information.
|
inline |
Get the flag which is used to decide whether to open the destination document in a new window or not.
foxit.pdf.actions.Action.NewWindowFlag.e_NewWindowFlagTrue means to open the destination document in a new window.
foxit.pdf.actions.Action.NewWindowFlag.e_NewWindowFlagFalse means that the destination document replaces current document in the same window.
foxit.pdf.actions.Action.NewWindowFlag.e_NewWindowFlagNone means that no such flag and the viewer application should behave in accordance with the current user preference.
|
inline |
Get the file specification of the root file which is the root file for the target.
|
inline |
Get the target.
|
inline |
Set the destination information which specifies where to jump to in the final target file.
[in] | destination | A valid destination object to be set. |
|
inline |
Set the destination name.
The destination name should have been in the "Dests" name tree in the target PDF file.
[in] | dest_name | A destination name to be set. It should not be an empty string. |
|
inline |
Set the flag which is used to decide whether to open the destination document in a new window or not.
[in] | flag | The new window flag. It should be one of following values:
|
|
inline |
Set the file specification of the root file which is the root file for the target.
[in] | file_specification | The file specification object:
|
|
inline |
Set the target.
[in] | target | An embedded goto target object. If this is constructed by default constructor and has not been set any value, that means no target. |