COM Interface Settings

You can access many profile settings through the COM interface that are available through PDFCreator as well.

Note

If you’d like to use accounts with the COM-Interface, you will have to set them up in the GUI and add them to a profile Please see Accounts to learn how to setup accounts.

There are two methods in the PrintJob to do so:

void SetProfileSetting(string name, string value)
string GetProfileSetting(string propertyName)

You access the property by name and pass a string containing the value. You can find the list of settings along with their names, types and a description below. The value is a string representation of the data type you want to set, i.e. “1.0” for double values or “true” for booleans.

Valid examples would be (in C# syntax):

Job.SetProfileSetting("PdfSettings.Signing.Enabled", "true");
Job.SetProfileSetting("PdfSettings.Signing.DisplaySignatureOnPage", "CustomPage");
Job.SetProfileSetting("PdfSettings.Signing.DisplaySignatureOnCustomPage", "5");

This will enable digital signatures for PDF files, set the “DisplaySignatureOnPage” enum to “CustomPage” and sets the integer value for the page to 5. Everything that C# can convert to the target type will be accepted here.

Note

If you are using numbers, please format them internationally (dot as decimal seperator, no thousands seperator) to ensure that they will be converted as desired.

Settings

Setting

Type

Description

ActionOrder

String

Order in which actions are processed by an executing job

AuthorTemplate

String

Template for the Author field. This may contain tokens.

FileNameTemplate

String

Template of which the filename will be created. This may contain Tokens.

Guid

String

GUID of the profile

KeywordTemplate

String

Template for the Keyword field. This may contain tokens.

Name

String

Name of the profile

OutputFormat

Enum

Default format for this print job. Valid values: Pdf, PdfA1B, PdfA2B, PdfA3B, PdfX, Jpeg, Png, Tif, Txt

SaveFileTemporary

Bool

Enable to save files only in a temp directory

ShowAllNotifications

Bool

Show a notification after converting the document

ShowOnlyErrorNotifications

Bool

Only show notification for error

ShowProgress

Bool

If true, a progress window will be shown during conversion

ShowQuickActions

Bool

Show quick actions page after converting the document

SkipSendFailures

Bool

Allows to skip send actions that fail, running all others.

SubjectTemplate

String

Template for the Subject field. This may contain tokens.

TargetDirectory

String

Directory in which the files will be saved (in interactive mode, this is the default location that is presented to the user)

TitleTemplate

String

Template for the Title field. This may contain tokens.

WarnSendFailures

Bool

When SkipSendFailures is active, allows to show a warning for failing send actions.

AttachmentPage

Appends one or more pages at the end of the converted document

AttachmentPage.Enabled

Bool

Enables the AttachmentPage action

AttachmentPage.Files

String

Filename of the PDF that will be appended

BackgroundPage

Adds a page background to the resulting document

BackgroundPage.Enabled

Bool

Enables the BackgroundPage action

BackgroundPage.File

String

Filename of the PDF that will be used as background

BackgroundPage.FitToPage

Bool

Enable to resize the background to fit the document page

BackgroundPage.Opacity

Int

Opacity for background in percent

BackgroundPage.Repetition

Enum

Defines the way the background document is repeated. Valid values: NoRepetition, RepeatAllPages, RepeatLastPage

CoverPage

Inserts one or more pages at the beginning of the converted document

CoverPage.Enabled

Bool

Enables the CoverPage action

CoverPage.Files

String

Filename of the PDF that will be inserted

CustomScript

Pre- and post-conversion actions calling functions from a custom script

CustomScript.Enabled

Bool

Enables the custom script pre- and post-conversion action

CustomScript.ScriptFilename

String

Filename of the custom script in application directory ‘Cs-Scripts’ folder

DropboxSettings

Dropbox settings for currently logged user

DropboxSettings.AccountId

String

ID of the linked account

DropboxSettings.CreateShareLink

Bool

DropboxSettings.Enabled

Bool

DropboxSettings.EnsureUniqueFilenames

Bool

If true, files with the same name will not be overwritten on the server. A counter will be appended instead (i.e. document_2.pdf)

DropboxSettings.SharedFolder

String

EmailClientSettings

Opens the default e-mail client with the converted document as attachment

EmailClientSettings.AddSignature

Bool

Add the PDFCreator signature to the mail

EmailClientSettings.AdditionalAttachments

String

The list of additional attachments for the e-mail

EmailClientSettings.Content

String

Body text of the e-mail

EmailClientSettings.Enabled

Bool

Enables the EmailClient action

EmailClientSettings.Format

Enum

Set the e-mail body format Valid values: Auto, Html, Text

EmailClientSettings.Recipients

String

The list of recipients of the e-mail, i.e. info@someone.com; me@mywebsite.org

EmailClientSettings.RecipientsBcc

String

The list of recipients of the e-mail in the ‘BCC’ field, i.e. info@someone.com; me@mywebsite.org

EmailClientSettings.RecipientsCc

String

The list of recipients of the e-mail in the ‘CC’ field, i.e. info@someone.com; me@mywebsite.org

EmailClientSettings.Subject

String

Subject line of the e-mail

EmailSmtpSettings

Sends a mail without user interaction through SMTP

EmailSmtpSettings.AccountId

String

ID of linked account

EmailSmtpSettings.AddSignature

Bool

Add the PDFCreator signature to the mail

EmailSmtpSettings.AdditionalAttachments

String

The list of additional attachments for the e-mail

EmailSmtpSettings.Content

String

Body text of the mail

EmailSmtpSettings.DisplayName

String

Display name for e-mail sender

EmailSmtpSettings.Enabled

Bool

If true, this action will be executed

EmailSmtpSettings.Format

Enum

Set the e-mail body format Valid values: Auto, Html, Text

EmailSmtpSettings.OnBehalfOf

String

If set it will be used as From and the address from the account will be set as Sender

EmailSmtpSettings.Recipients

String

The list of recipients of the e-mail, i.e. info@someone.com; me@mywebsite.org

EmailSmtpSettings.RecipientsBcc

String

The list of recipients of the e-mail in the ‘BCC’ field, i.e. info@someone.com; me@mywebsite.org

EmailSmtpSettings.RecipientsCc

String

The list of recipients of the e-mail in the ‘CC’ field, i.e. info@someone.com; me@mywebsite.org

EmailSmtpSettings.ReplyTo

String

Specifies an address that should be used to reply to the e-mail

EmailSmtpSettings.Subject

String

Subject line of the e-mail

ForwardToFurtherProfile

ForwardToFurtherProfile.Enabled

Bool

ForwardToFurtherProfile.ProfileGuid

String

Ftp

Upload the converted documents with FTP

Ftp.AccountId

String

ID of the linked account

Ftp.Directory

String

Target directory on the server

Ftp.Enabled

Bool

If true, this action will be executed

Ftp.EnsureUniqueFilenames

Bool

If true, files with the same name will not be overwritten on the server. A counter will be appended instead (i.e. document_2.pdf)

Ghostscript

Ghostscript settings

Ghostscript.AdditionalGsParameters

String

These parameters will be provided to Ghostscript in addition to the PDFCreator parameters

HttpSettings

Action to upload files to a HTTP server

HttpSettings.AccountId

String

HttpSettings.Enabled

Bool

If true, this action will be executed

JpegSettings

Settings for the JPEG output format

JpegSettings.Color

Enum

Number of colors. Valid values: Color24Bit, Gray8Bit

JpegSettings.Dpi

Int

Resolution of the JPEG files

JpegSettings.Quality

Int

Quality factor of the resulting JPEG (100 is best, 0 is worst)

PdfSettings

Settings for the PDF output format

PdfSettings.ColorModel

Enum

Color model of the PDF (does not apply to images). Valid values: Rgb, Cmyk, Gray

PdfSettings.DocumentView

Enum

Defines which controls will be opened in the reader. Valid values: NoOutLineNoThumbnailImages, Outline, ThumbnailImages, FullScreen, ContentGroupPanel, AttachmentsPanel

PdfSettings.EnablePdfAValidation

Bool

Enable PDF/A validation

PdfSettings.NoFonts

Bool

If enabled, no fonts will be embedded into the output.

PdfSettings.PageOrientation

Enum

Define how pages are automatically rotated. Valid values: Automatic, Portrait, Landscape

PdfSettings.PageView

Enum

Defines how the document will be opened in the reader. Valid values: OnePage, OneColumn, TwoColumnsOddLeft, TwoColumnsOddRight, TwoPagesOddLeft, TwoPagesOddRight

PdfSettings.ViewerStartsOnPage

Int

Defines the page number the viewer will start on when opening the document

CompressColorAndGray

Compression settings for color and greyscale images

PdfSettings.CompressColorAndGray.Compression

Enum

Settings for the compression method. Valid values: Automatic, JpegMaximum, JpegHigh, JpegMedium, JpegLow, JpegMinimum, JpegManual, Zip

PdfSettings.CompressColorAndGray.Dpi

Int

Images will be resampled to this maximum resolution of the images, if resampling is enabled

PdfSettings.CompressColorAndGray.Enabled

Bool

If true, color and grayscale images will be processed according to the algorithm. If false, they will remain uncompressed

PdfSettings.CompressColorAndGray.JpegCompressionFactor

Double

Define a custom compression factor (requires JpegManual as method)

PdfSettings.CompressColorAndGray.Resampling

Bool

If true, the images will be resampled to a maximum resolution

CompressMonochrome

Compression settings for monochrome images

PdfSettings.CompressMonochrome.Compression

Enum

Settings for the compression method. Valid values: CcittFaxEncoding, Zip, RunLengthEncoding

PdfSettings.CompressMonochrome.Dpi

Int

Images will be resampled to this maximum resolution of the images, if resampling is enabled

PdfSettings.CompressMonochrome.Enabled

Bool

If true, monochrome images will be processed according to the algorithm. If false, they will remain uncompressed

PdfSettings.CompressMonochrome.Resampling

Bool

If true, the images will be resampled to a maximum resolution

Security

PDF Security options

PdfSettings.Security.AllowPrinting

Bool

Allow to user to print the document

PdfSettings.Security.AllowScreenReader

Bool

Allow to user to use a screen reader

PdfSettings.Security.AllowToCopyContent

Bool

Allow to user to copy content from the PDF

PdfSettings.Security.AllowToEditAssembly

Bool

Allow to user to make changes to the assembly

PdfSettings.Security.AllowToEditComments

Bool

Allow to user to edit comments

PdfSettings.Security.AllowToEditTheDocument

Bool

Allow to user to edit the document

PdfSettings.Security.AllowToFillForms

Bool

Allow to user to fill in forms

PdfSettings.Security.Enabled

Bool

If true, the PDF file will be password protected

PdfSettings.Security.EncryptionLevel

Enum

Defines the encryption level. Valid values: Rc40Bit, Rc128Bit, Aes128Bit, Aes256Bit

PdfSettings.Security.OwnerPassword

String

Password that can be used to modify the document

PdfSettings.Security.RequireUserPassword

Bool

If true, a password is required to open the document.

PdfSettings.Security.RestrictPrintingToLowQuality

Bool

If true, only printing in low resolution will be supported

PdfSettings.Security.UserPassword

String

Password that must be used to open the document (if set)

Signature

Digitally sign the PDF document

PdfSettings.Signature.AllowMultiSigning

Bool

If true, the PDF file may be signed by additional persons

PdfSettings.Signature.CertificateFile

String

Path to the certificate

PdfSettings.Signature.DisplaySignatureInDocument

Bool

If true, the signature will be displayed in the PDF file

PdfSettings.Signature.Enabled

Bool

If true, the signature will be displayed in the PDF document

PdfSettings.Signature.LeftX

Float

Signature location: Top left corner (X part)

PdfSettings.Signature.LeftY

Float

Signature location: Top left corner (Y part)

PdfSettings.Signature.RightX

Float

Signature location: Bottom right corner (X part)

PdfSettings.Signature.RightY

Float

Signature location: Bottom right corner (Y part)

PdfSettings.Signature.SignContact

String

Contact name of the signature

PdfSettings.Signature.SignLocation

String

Signature location

PdfSettings.Signature.SignReason

String

Reason for the signature

PdfSettings.Signature.SignatureCustomPage

Int

If the signature page is set to custom, this property defines the page where the signature will be displayed

PdfSettings.Signature.SignaturePage

Enum

Defines the page on which the signature will be displayed. Valid values: FirstPage, LastPage, CustomPage

PdfSettings.Signature.SignaturePassword

String

Password for the certificate file

PdfSettings.Signature.TimeServerAccountId

String

ID of the linked account for the timeserver

PngSettings

Settings for the PNG output format

PngSettings.Color

Enum

Number of colors. Valid values: Color32BitTransp, Color24Bit, Color8Bit, Color4Bit, Gray8Bit, BlackWhite

PngSettings.Dpi

Int

Resolution of the PNG files

Printing

Print the document to a physical printer

Printing.Duplex

Enum

Defines the duplex printing mode. Valid values: Disable, LongEdge, ShortEdge

Printing.Enabled

Bool

If enabled, the document will be printed to a physical printer

Printing.FitToPage

Bool

If set, the pages of the document will be adjusted to the paper size of the printer.

Printing.PrinterName

String

Name of the printer that will be used, if SelectedPrinter is set.

Printing.SelectPrinter

Enum

Method to select the printer. Valid values: DefaultPrinter, ShowDialog, SelectedPrinter

Scripting

The scripting action allows to run a script after the conversion

Scripting.Enabled

Bool

If true, the given script or application will be executed

Scripting.ParameterString

String

Parameters that will be passed to the script in addition to the output files

Scripting.ScriptFile

String

Path to the script or application

Scripting.Visible

Bool

If false, the given script or application will be executed in a hidden window

Scripting.WaitForScript

Bool

Wait until the script execution has ended

Stamping

Place a stamp text on all pages of the document

Stamping.Color

Color

Color of the text

Stamping.Enabled

Bool

If true, the document all pages will be stamped with a text

Stamping.FontAsOutline

Bool

If true, the text will be rendered as outline. If false, it will be filled.

Stamping.FontFile

String

PostScript name of the stamp font.

Stamping.FontName

String

Name of the font. (this is only used as a hint, the PostScriptFontName contains the real name)

Stamping.FontOutlineWidth

Int

Width of the outline

Stamping.FontSize

Float

Size of the font

Stamping.StampText

String

Text that will be stamped

TextSettings

TextSettings.Format

Int

Text Format (0 outputs XML-escaped Unicode along with information regarding the format of the text | 1 same XML output format, but attempts similar processing to MuPDF, and will output blocks of text | 2 outputs Unicode (UCS2) text (with a Byte Order Mark) which approximates the original text layout | 3 same as 2 encoded in UTF-8)

TiffSettings

Settings for the TIFF output format

TiffSettings.Color

Enum

Number of colors. Valid values: Color24Bit, Color12Bit, Gray8Bit, BlackWhiteG3Fax, BlackWhiteG4Fax, BlackWhiteLzw

TiffSettings.Dpi

Int

Resolution of the TIFF files

UserTokens

Parse ps files for user defined tokens

UserTokens.Enabled

Bool

Activate parsing ps files for user tokens (Only available in the PDFCreator business editions)

UserTokens.Seperator

Enum

UserToken separator in the document Valid values: SquareBrackets, AngleBrackets,

Watermark

Adds a watermark to the resulting document

Watermark.Enabled

Bool

Enables the WatermarkAction

Watermark.File

String

Filename of the PDF that will be used as watermark

Watermark.FitToPage

Bool

Enable to resize the watermark to fit the document page

Watermark.Opacity

Int

Opacity for watermark in percent

Watermark.Repetition

Enum

Defines the way the watermark document is repeated Valid values: NoRepetition, RepeatAllPages, RepeatLastPage