|
PDF2XL CLI Online Help
Table of Contents Command Line Interface Commands
Commands
Each command will appear after a space, and if it has a value, it will be separated from it using an equal sign. If the value contains spaces, it MUST start and end with quotes, which will be removed from the value itself. If a quoted value has a quote inside, it needs to be doubled. See the CLI Examples for samples on the usage of the commands and quotes.
PDF2XL CLI will return an error code if there was a problem with the command line.
| Command | Value | Description | Notes |
| -input | <filename> | Loads the file | Can appear more then once, unless the Silent Mode or Managed Mode commands are used, in which case it must appear exactly once |
| -layout | <filename> | Loads a layout from the file | Will be used on all the input flag files; overrides the layout saved for the input file (if any) |
| -format | excel | excelfile | word | wordfile | powerpoint | powerpointfile | calcfile | csvfile | clipboard | excelclipboard | wordclipboard | Sets the current conversion format | Overrides the saved setting |
| -output | <filename> | Sets the output filename for Excel, Word or CSV file conversions | Only valid when format appears and is set to excelfile, wordfile or csvfile |
| -range | All | current | ask | <num>[-<num>][,<num>[-<num>]]... | Sets the conversion page range | Isn't valid if the document is a Scanned PDF Document |
| -noui | | Runs the application in Silent Mode | Command line has to include input; will fail if no layout is defined for the file, or if converting to a file without an output file, or if the page range is set to current. |
| -autoclose | | Closes the file when it is converted; closes the application when the last file is converted | Implied when Silent Mode command is used |
| -run | | Converts the opened document immediately | Command line must include input; will fail if no layout is defined for the file, or if converting to a file without an output file, or if the page range is set to current |
| -managed | | Runs the application in Managed Mode | Command line must include the input flag; will fail if format command is set to excel file and no output is defined; cannot be used in conjunction with Silent Mode |
| -autoconvert | | Converts the file when the document is closed | Cannot be used with autoconvertwarn command or when running in Silent Mode |
| -autoconvertwarn | | Same as -autoconvert, but warns the user before closing if no conversion is possible (no layout, for example) | Cannot be used with autoconvert or when running in Silent Mode |
| -tutorial | on | off | Shows or hides the tutorial | Overrides the saved setting |
| -preview | on | off | Shows or hides the Conversion Preview area | Overrides the saved setting |
| -status | on | off | Shows or hides the status bar | Overrides the saved setting |
| -password | <password> | Password to open password-protected documents with | Valid only in combination with Silent Mode command |
| -autoopen | on | off | If set to on, will open the Excel or Word file when the conversion is finished. If set to off, will not display the file. If not specified, PDF2XL CLI will use the Open File after Conversion setting in the Conversion Settings page | Valid only in combination with Silent Mode command |
|
|