PDFCreator

https://docs.pdfforge.org/pdfcreator/en/
Admin
A user guide for PDFCreator, a software that creates PDFs, covering installation, usage, settings,...
Tokens:62,848
Snippets:1,019
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Set Installation Log File Path

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/setup-command-line-parameters

Define the file path where the setup process will save its installation log.

```bash
/LogFile=<PathToLogFile>
```

--------------------------------

### Install PDFCreator with Custom Parameters (Example)

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/chocolatey-installation

This example demonstrates how to disable desktop icons and set the software language to German using custom parameters.

```bash
choco install <package-id> --ia="/NoIcons /Lang=de"

```

--------------------------------

### Example: Install PDFCreator with Custom Parameters (No Icons, German Language)

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/winget-installation

This example demonstrates installing PDFCreator with custom parameters to disable desktop icons and set the software language to German. The custom parameters are wrapped in double quotes.

```bash
winget install <package-id> --custom "/NoIcons /Lang=de"

```

--------------------------------

### Install Specific Components

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator-server/installing-pdfcreator/setup-command-line-parameters

Use the /COMPONENTS parameter to select which additional components to install. Specify 'pdfarchitect' and 'images2pdf' to install both, or 'none' to install no additional components. If omitted, all available components are installed.

```bash
/COMPONENTS="pdfarchitect,images2pdf"
```

```bash
/COMPONENTS="none"
```

--------------------------------

### Set Installation Language

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/setup-command-line-parameters

Specify the desired language for the setup using its two-letter ISO code. Defaults to the system's language if not provided.

```bash
/Lang=en
```

--------------------------------

### Basic MSI Installation

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/msi-installer

Install PDFCreator with a license key using the MSI installer from the command line.

```bash
PDFCreator-X_X_X-setup.msi LICENSEKEY=<YOUR-LICENSEKEY>
```

--------------------------------

### Create a New Conversion Profile

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/pdfcreator-settings/predefine-settings/create-default-settings

This example shows the steps to create a new conversion profile by defining a unique GUID and other desired settings within the registry. This allows for custom profile configurations.

```powershell
reg add "HKEY_USERS\.DEFAULT\Software\pdfforge\PDFCreator\Settings\ConversionProfiles\0" /v Guid /t REG_SZ /d "{YOUR_UNIQUE_GUID}" /f
```

--------------------------------

### Create Administrative Installation Point with Features

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/msi-installer

Create an administrative installation point including specific features like MAINPROGRAM and IMAGES2PDF.

```bash
msiexec /a PDFCreator-X_X_X-setup-pdfforge.msi TARGETDIR=C:\PDFCreator_AIP
   LICENSEKEY=01234-56789-ABCDE-FGHIJ-KLMNO-PQRST ADDLOCAL=MAINPROGRAM,IMAGES2PDF
```

--------------------------------

### Get Help for PDFCreator CLI

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/using-pdfcreator/command-line-parameters

Call 'help' to get an overview of all available commands in the PDFCreator CLI. This is the starting point for exploring its capabilities.

```bash
pdfcreator-cli.exe help

```

--------------------------------

### Create Administrative Installation Point with Proxy

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/msi-installer

Create an administrative installation point with proxy configuration for network deployment.

```bash
msiexec /a PDFCreator-X_X_X-setup-pdfforge.msi TARGETDIR=C:\PDFCreator_AIP
   LICENSEKEY=01234-56789-ABCDE-FGHIJ-KLMNO-PQRST PROXYNAME=proxy1:8088
   PROXYUSERNAME=JohnSmith PROXYPASSWORD=MyPassword
```

--------------------------------

### Install PDFCreator Free

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/chocolatey-installation

Use this command to install the free version of PDFCreator. The installation is silent by default.

```bash
choco install pdfcreator

```

--------------------------------

### Install PDFCreator with Specific Components

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/setup-command-line-parameters

Use the /COMPONENTS parameter to specify which additional components to install. You can select 'pdfarchitect' and 'images2pdf', or set to 'none' to install no additional components. If omitted, all available components are installed.

```bash
/COMPONENTS="pdfarchitect,images2pdf"

```

```bash
/COMPONENTS="none"

```

--------------------------------

### MSI Installation with Proxy Settings

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/msi-installer

Install PDFCreator with license key and proxy configuration details.

```bash
PDFCreator-X_X_X-setup-pdfforge.msi LICENSEKEY=01234-56789-ABCDE-FGHIJ-KLMNO-PQRST
   PROXYNAME=proxy1:8088 PROXYUSERNAME=JohnSmith PROXYPASSWORD=MyPassword
```

--------------------------------

### MSI Installation with Specific Features

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/msi-installer

Install PDFCreator with a license key and specify which features to include using the ADDLOCAL parameter.

```bash
PDFCreator-X_X_X-setup-pdfforge.msi LICENSEKEY=01234-56789-ABCDE-FGHIJ-KLMNO-PQRST
   ADDLOCAL=MAINPROGRAM
```

```bash
PDFCreator-X_X_X-setup-pdfforge.msi LICENSEKEY=01234-56789-ABCDE-FGHIJ-KLMNO-PQRST
   ADDLOCAL=MAINPROGRAM,IMAGES2PDF
```

--------------------------------

### Install PDFCreator with Custom Parameters

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/chocolatey-installation

Use the --install-args flag to pass custom parameters to the installer. Custom parameters should be wrapped in double quotes.

```bash
choco install <package-id> --ia="<params>"

```

--------------------------------

### Create Administrative Installation Point

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/msi-installer

Create an administrative installation point for PDFCreator using msiexec, specifying the target directory and license key.

```bash
msiexec /a PDFCreator-X_X_X-setup-pdfforge.msi TARGETDIR=C:\PDFCreator_AIP
   LICENSEKEY=01234-56789-ABCDE-FGHIJ-KLMNO-PQRST
```

--------------------------------

### Configure PDFCreator MSI Installer with ILS

Source: https://docs.pdfforge.org/pdfcreator/en/InternalLicenseServer/Installation-and-Quick-Guide

Use this command to install PDFCreator via its MSI installer and configure it to use the Internal License Server. Replace placeholders with your actual license key and ILS IP address/port.

```bash
PDFCreator-EDITION-X_X_X-setup_x64.msi LICENSEKEY=<YOUR-LICENSEKEY> 
  INTERNALLICENSESERVERURL=http://<INTERNAL-LICENSE-SERVER-IP-ADDRESS>:<PORT>
```

--------------------------------

### Configure PDFCreator EXE Installer with ILS

Source: https://docs.pdfforge.org/pdfcreator/en/InternalLicenseServer/Installation-and-Quick-Guide

Use this command to install PDFCreator via its EXE installer and configure it to use the Internal License Server. Replace placeholders with your actual license key and ILS IP address/port.

```bash
PDFCreator-EDITION-X_X_X-Setup.exe /LicenseKey=<YOUR-LICENSEKEY> 
  /InternalLicenseServerURL=http://<INTERNAL-LICENSE-SERVER-IP-ADDRESS>:<PORT>
```

--------------------------------

### Initialize PDFCreator Job Queue

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/com-interface/user-manual/basics/convert-multiple-files

Get a reference to the PDFCreator job queue and initialize it. Sets up the path for converted files.

```javascript
var PDFCreatorQueue = new ActiveXObject("PDFCreator.JobQueue");
PDFCreatorQueue.Initialize();

//Sets up the path where the converted files should be saved in
var fullPath = objFSO.GetParentFolderName(WScript.ScriptFullname) + "\\TestPage.pdf";

```

--------------------------------

### Override Default Installation Directory

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/setup-command-line-parameters

Use this parameter to specify a custom installation path. The path must be fully qualified and should end with 'PDFCreator', which will be appended if omitted.

```bash
/Dir="x:\\dirname\\PDFCreator"
```

--------------------------------

### Initialize PDFCreator Job Queue

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/com-interface/user-manual/basics/convert-single-file

Get a reference to the PDFCreator job queue and initialize it. This is the first step in setting up a conversion workflow.

```javascript
var PDFCreatorQueue = new ActiveXObject("PDFCreator.JobQueue");
PDFCreatorQueue.Initialize();

//Sets up the path where the converted pdf file should be saved in
var fullPath = objFSO.GetParentFolderName(WScript.ScriptFullname) + "\\TestPage.pdf";

```

--------------------------------

### Get Activation Code

Source: https://docs.pdfforge.org/pdfcreator/en/InternalLicenseServer/Manage-your-licenses-with-the-ILS-CLI

Retrieve the activation code for the Internal License Server. This command does not require any verb.

```bash
ils-cli.exe activation-code
```

--------------------------------

### Initialize PDFCreator Job Queue

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/com-interface/user-manual/how-to/change-default-output-format

Get a reference to the job queue and initialize it. This is the first step to interacting with PDFCreator's COM interface.

```javascript
var PDFCreatorQueue = new ActiveXObject("PDFCreator.JobQueue");
PDFCreatorQueue.Initialize();

var fullname = objFSO.GetFileName(filename);
var name =  fullname.replace(objFSO.GetExtensionName(fullname),"pdf");

//Sets up the path where the converted pdf file should be saved in
var fullPath = objFSO.GetParentFolderName(WScript.ScriptFullname) + "\includegraphics[width=0.5\textwidth]{/Users/runner/work/1/s/pdfcreator/com-interface/user-manual/how-to/change-default-output-format.md}" + name;

```

--------------------------------

### Example Usage of DateTime Token for Year

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/using-pdfcreator/tokens

Demonstrates using the <DateTime> token to extract and display the current year as a 4-digit number.

```text
<DateTime:yyyy>
```

--------------------------------

### Set Job Profile by GUID

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/com-interface/user-manual/how-to/order-actions-manually

Assigns a conversion profile to the current job using its unique identifier (GUID). Use predefined GUIDs for standard profiles.

```javascript
job.SetProfileByGuid("DefaultGuid");
```

--------------------------------

### Install Specific Version of PDFCreator

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/chocolatey-installation

Install a specific version of PDFCreator by providing the package ID and version number. If no version is specified, the latest stable version is installed.

```bash
choco install <package-id> --version <version-number>

```

--------------------------------

### Import a License from File

Source: https://docs.pdfforge.org/pdfcreator/en/InternalLicenseServer/Manage-your-licenses-with-the-ILS-CLI

Import a new license into the Internal License Server by providing the path to the license file.

```bash
ils-cli.exe licenses import <License File Path>
```

--------------------------------

### Set Logging Level to Info

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/pdfcreator-settings/predefine-settings/create-default-settings

This example demonstrates how to change the logging level to 'Info' by creating a specific registry value. This is useful when you need more detailed logs for troubleshooting.

```powershell
reg add "HKEY_USERS\.DEFAULT\Software\pdfforge\PDFCreator\Settings\ApplicationSettings" /v LoggingLevel /t REG_SZ /d "Info" /f
```

--------------------------------

### SetProfileByGuid

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/com-interface/reference/print-job

Sets the conversion profile for a print job using its unique GUID. This method is reliable as GUIDs are stable identifiers for profiles.

```APIDOC
## void SetProfileByGuid(string profileGuid)

### Description
Sets the conversion profile for a print job using its unique GUID. This method is reliable as GUIDs are stable identifiers for profiles.

### Method
void

### Parameters
#### Path Parameters
- **profileGuid** (string) - Required - Specifies the GUID of the profile to be used.

### Predefined GUIDs
PDFCreator includes predefined profiles with human-readable GUIDs for common conversion types:
- **DefaultGuid**: Creates PDF files.
- **PdfaGuid**: Creates PDF/A files.
- **PrintGuid**: Sends output to a printer after conversion.
- **HighCompressionGuid**: Creates PDFs with high compression images.
- **HighQualityGuid**: Creates PDFs with high quality images.
- **JpegGuid**: Creates JPEG files.
- **PngGuid**: Creates PNG files.
- **TiffGuid**: Creates TIFF files.
```

--------------------------------

### Start File Conversion

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/com-interface/user-manual/basics/convert-single-file

Initiate the conversion of the print job to a PDF file at the specified path. The path variable should include the desired filename and extension.

```javascript
job.ConvertTo(fullPath); //the variable fullPath was introduced in line 31

```

--------------------------------

### Perform Very Silent Installation

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/setup-command-line-parameters

Use the /VerySilent parameter for a completely unattended installation. The system may reboot without user confirmation if required.

```bash
/VerySilent
```

--------------------------------

### Example Usage of DateTime Token in Filename

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/using-pdfcreator/tokens

Demonstrates how to use the <DateTime> token with a specific format to create dynamic filenames. The token sorts files by year and month.

```text
MyInvoice<DateTime:yyyy-mm>
```

--------------------------------

### Initialize PDFCreator Settings via CLI

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/using-pdfcreator/command-line-parameters

Use 'InitializeSettings' to set up PDFCreator's registry settings as if performing a regular application start. This is useful for preparing settings before further modifications.

```bash
pdfcreator-cli.exe InitializeSettings

```

--------------------------------

### Set Conversion Profile by GUID

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/com-interface/user-manual/how-to/add-cover-page

Configure the job's conversion profile using its unique identifier (GUID). Alternatively, SetProfileByName can be used.

```javascript
job.SetProfileByGuid("DefaultGuid");

```

--------------------------------

### Example Usage of ClientComputer Token in Autosave Directory

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/using-pdfcreator/tokens

Shows how to use the <ClientComputer> token to specify a network share on a client's computer as the autosave directory.

```text
\\<ClientComputer>\MyShare
```

--------------------------------

### Set Conversion Profile by GUID

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/com-interface/user-manual/how-to/change-jpeg-settings

Assign a specific conversion profile to the job using its unique identifier (GUID). Alternatively, SetProfileByName can be used.

```javascript
job.SetProfileByGuid("JpegGuid");

```

--------------------------------

### Specify Internal License Server URL

Source: https://docs.pdfforge.org/pdfcreator/en/pdfcreator/installing-pdfcreator/setup-command-line-parameters

If using an internal license server, provide its URL using this parameter to direct the setup for license activation.

```bash
/InternalLicenseServerUrl=<YourInternalLicenseServerUrl>
```

--------------------------------

### Display Help for Machines Commands

Source: https://docs.pdfforge.org/pdfcreator/en/InternalLicenseServer/Manage-your-licenses-with-the-ILS-CLI

Execute this command to view all available subcommands and options for managing machines with the ILS-CLI.

```bash
ils-cli.exe help machines
```

--------------------------------

### List All Licenses

Source: https://docs.pdfforge.org/pdfcreator/en/InternalLicenseServer/Manage-your-licenses-with-the-ILS-CLI

Use this command to retrieve a list of all licenses currently managed by the Internal License Server.

```bash
ils-cli.exe licenses list
```
Tokens:
Raw