|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetFileSpec () |
| Get the file specification which specifies the application to be launched or the document to be opened or printed. More... | |
| def | GetNewWindowFlag () |
| Get the flag which is used to decide whether to open the destination document in a new window or not. More... | |
| def | GetWinAppOperation () |
| (Windows-specific launch parameters) Get the operation name. More... | |
| def | GetWinAppParameter () |
| (Windows-specific launch parameters) Get parameter string to be passed to the specified application. More... | |
| def | GetWinDefaultDirectory () |
| (Windows-specific launch parameters) Get the default directory in standard DOS syntax. More... | |
| def | GetWinFileName () |
| (Windows-specific launch parameters) Get the file name of the application to be launched or the document to be opened or printed. More... | |
| def | SetFileSpec (file_specification) |
| Set a file specification which specifies an application to be launched or a document to be opened or printed. More... | |
| def | SetNewWindowFlag (flag) |
| Set the flag which is used to decide whether to open the destination document in a new window or not. More... | |
| def | SetWinLaunchParameter (file_name, default_directory, operation, app_parameter) |
| (Windows-specific launch parameters)Set Windows-specific launch parameters. More... | |
Launch action is to launch an application, usually to open a file. Class fsdk.LaunchAction is derived from Action and offers functions to get/set launch action data.
| def fsdk.LaunchAction.GetFileSpec | ( | ) |
Get the file specification which specifies the application to be launched or the document to be opened or printed.
| def fsdk.LaunchAction.GetNewWindowFlag | ( | ) |
Get the flag which is used to decide whether to open the destination document in a new window or not.
fsdk.ActionE_NewWindowFlagTrue means to open the destination document in a new window.
fsdk.ActionE_NewWindowFlagFalse means that the destination document replaces current document in the same window.
fsdk.ActionE_NewWindowFlagNone means that no such flag and the viewer application should behave in accordance with the current user preference.
| def fsdk.LaunchAction.GetWinAppOperation | ( | ) |
(Windows-specific launch parameters) Get the operation name.
Standard strings for operation name are:
"open": Open a document.
"print": Print a document
If the file name of Windows-specific launch parameters represents an application, the operation name would be useless for current action.
| def fsdk.LaunchAction.GetWinAppParameter | ( | ) |
(Windows-specific launch parameters) Get parameter string to be passed to the specified application.
If the file name of Windows-specific launch parameters represents a document, app parameter string will be ignored.
| def fsdk.LaunchAction.GetWinDefaultDirectory | ( | ) |
(Windows-specific launch parameters) Get the default directory in standard DOS syntax.
| def fsdk.LaunchAction.GetWinFileName | ( | ) |
(Windows-specific launch parameters) Get the file name of the application to be launched or the document to be opened or printed.
| def fsdk.LaunchAction.SetFileSpec | ( | file_specification | ) |
Set a file specification which specifies an application to be launched or a document to be opened or printed.
| [in] | file_specification | A valid file specification object. This object should be in the same document with current action object. |
| def fsdk.LaunchAction.SetNewWindowFlag | ( | flag | ) |
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:
|
| def fsdk.LaunchAction.SetWinLaunchParameter | ( | file_name, | |
| default_directory, | |||
| operation, | |||
| app_parameter | |||
| ) |
(Windows-specific launch parameters)Set Windows-specific launch parameters.
This function is used to set Windows-specific launch parameters. Parameter file_name is necessary and can represent either an application or a document. When parameter file_name represents an application, parameters operation and app_parameter are useless.
| [in] | file_name | The file name of the application to be launched or the document to be opened or printed. It should not be an empty string. |
| [in] | default_directory | Default directory in standard DOS syntax. |
| [in] | operation | Operation name. This can be an empty string. If this is not an empty string, it should be one of following strings:
|
| [in] | app_parameter | Parameter string to be passed to the specified application. |