COM Interface Settings

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

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
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
Name String Name of the profile
OpenViewer Bool Open the default viewer after converting the document
OpenWithPdfArchitect Bool If the output is a PDF, use PDF Architect instead of the default PDF viewer
OutputFormat Enum Default format for this print job. Valid values are: Pdf, PdfA, PdfX, Jpeg, Png, Tif
ShowProgress Bool If true, a progress window will be shown during conversion
TitleTemplate String Template for the Title field. This may contain tokens.
AttachmentPage
Appends one or more pages at the end of the converted document
AttachmentPage.Enabled Bool Enables the AttachmentPage action
AttachmentPage.File 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.OnAttachment Bool If true, the background will be placed on the attachment as well
BackgroundPage.OnCover Bool If true, the background will be placed on the cover as well
BackgroundPage.Repetition Enum Defines the way the background document is repeated. Valid values are: NoRepetition, RepeatAllPages, RepeatLastPage
CoverPage
Inserts one or more pages at the beginning of the converted document
CoverPage.Enabled Bool Enables the CoverPage action
CoverPage.File String Filename of the PDF that will be inserted
EmailClient
Opens the default E-mail client with the converted document as attachment
EmailClient.Content String Body text of the E-mail
EmailClient.Enabled Bool Enables the EmailClient action
EmailClient.Recipients String The list of receipients of the E-mail, i.e. info@someone.com; me@mywebsite.org
EmailClient.Signature String The signature text will be appended at the end of the mail
EmailClient.Subject String Subject line of the E-mail
EmailSmtp
Sends a mail without user interaction through SMTP
EmailSmtp.Address String E-mail address that is displayed as sender
EmailSmtp.Content String Body text of the mail
EmailSmtp.Enabled Bool If true, this action will be executed
EmailSmtp.Password String Password that is used to authenticate at the server
EmailSmtp.Port Int SMTP server port
EmailSmtp.Recipients String The list of receipients of the E-mail, i.e. info@someone.com; me@mywebsite.org
EmailSmtp.SameTextAsClientMail Bool If true, the body of the EmailClient action will be used
EmailSmtp.Server String Hostname or IP address of the SMTP server
EmailSmtp.Signature String The signature text will be appended at the end of the mail
EmailSmtp.Ssl Bool If true, the connection will be encrypted with SSL (must be supported by the server)
EmailSmtp.Subject String Subject line of the E-mail
EmailSmtp.UserName String User name that is used to authenticate at the server
Ftp
Upload the converted documents with FTP
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)
Ftp.Password String Password that is used to authenticate at the server
Ftp.Server String Hostname or IP address of the FTP server
Ftp.UserName String User name that is used to authenticate at the server
Ghostscript
Ghostscript settings
Ghostscript.AdditionalGsParameters String These parameters will be provided to Ghostscript in addition to the PDFCreator parameters
JpegSettings
Settings for the JPEG output format
JpegSettings.Color Enum Number of colors. Valid values are: 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 are: Rgb, Cmyk, Gray
PdfSettings.DocumentView Enum Defines which controls will be opened in the reader. Valid values are: NoOutLineNoThumbnailImages, Outline, ThumbnailImages, FullScreen, ContentGroupPanel, AttachmentsPanel
PdfSettings.FastWebView Bool If true, the PDF will be linearized, which allows the first pages to be displayed even if the rest of the document still is loading.
PdfSettings.PageOrientation Enum Define how pages are automatically rotated. Valid values are: Automatic, Portrait, Landscape
PdfSettings.PageView Enum Defines how the document will be opened in the reader. Valid values are: 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
CompressColorAndGray.Compression Enum Settings for the compression method. Valid values are: Automatic, JpegMaximum, JpegHigh, JpegMedium, JpegLow, JpegMinimum, JpegManual, Zip
CompressColorAndGray.Dpi Int Images will be resampled to this maximum resolution of the images, if resampling is enabled
CompressColorAndGray.Enabled Bool If true, color and grayscale images will be processed according to the algorithm. If false, they will remain uncompressed
CompressColorAndGray.JpegCompressionFactor Double Define a custom compression factor (requires JpegManual as method)
CompressColorAndGray.Resampling Bool If true, the images will be resampled to a maximum resolution
CompressMonochrome
Compression settings for monochrome images
CompressMonochrome.Compression Enum Settings for the compression method. Valid values are: CcittFaxEncoding, Zip, RunLengthEncoding
CompressMonochrome.Dpi Int Images will be resampled to this maximum resolution of the images, if resampling is enabled
CompressMonochrome.Enabled Bool If true, monochrome images will be processed according to the algorithm. If false, they will remain uncompressed
CompressMonochrome.Resampling Bool If true, the images will be resampled to a maximum resolution
Security
PDF Security options
Security.AllowPrinting Bool Allow to user to print the document
Security.AllowScreenReader Bool Allow to user to use a screen reader
Security.AllowToCopyContent Bool Allow to user to copy content from the PDF
Security.AllowToEditAssembly Bool Allow to user to make changes to the assembly
Security.AllowToEditComments Bool Allow to user to edit comments
Security.AllowToEditTheDocument Bool Allow to user to edit the document
Security.AllowToFillForms Bool Allow to user to fill in forms
Security.Enabled Bool If true, the PDF file will be password protected
Security.EncryptionLevel Enum Defines the encryption level. Valid values are: Rc40Bit, Rc128Bit, Aes128Bit
Security.OwnerPassword String Password that can be used to modify the document
Security.RequireUserPassword Bool If true, a password is required to open the document.
Security.RestrictPrintingToLowQuality Bool If true, only printing in low resolution will be supported
Security.UserPassword String Password that must be used to open the document (if set)
Signature
Digitally sign the PDF document
Signature.AllowMultiSigning Bool If true, the PDF file may be signed by additional persons
Signature.CertificateFile String Path to the certificate
Signature.DisplaySignatureInDocument Bool If true, the signature will be displayed in the PDF file
Signature.Enabled Bool If true, the signature will be displayed in the PDF document
Signature.LeftX Int Signature location: Top left corner (X part)
Signature.LeftY Int Signature location: Top left corner (Y part)
Signature.RightX Int Signature location: Bottom right corner (X part)
Signature.RightY Int Signature location: Bottom right corner (Y part)
Signature.SignContact String Contact name of the signature
Signature.SignLocation String Signature location
Signature.SignReason String Reason for the signature
Signature.SignatureCustomPage Int If the signature page is set to custom, this property defines the page where the signature will be displayed
Signature.SignaturePage Enum Defines the page on which the signature will be displayed. Valid values are: FirstPage, LastPage, CustomPage
Signature.SignaturePassword String Password for the certificate file
Signature.TimeServerIsSecured Bool Set to true, if the time server needs authentication
Signature.TimeServerLoginName String Login name for the time server
Signature.TimeServerPassword String Password for the time server
Signature.TimeServerUrl String URL of a time server that provides a signed timestamp
PngSettings
Settings for the PNG output format
PngSettings.Color Enum Number of colors. Valid values are: 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 are: Disable, LongEdge, ShortEdge
Printing.Enabled Bool If enabled, the document will be printed to a physical 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 are: 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.WaitForScript Bool Wait until the script excution 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.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.PostScriptFontName String PostScript name of the stamp font.
Stamping.StampText String Text that will be stamped
TiffSettings
Settings for the TIFF output format
TiffSettings.Color Enum Number of colors. Valid values are: Color24Bit, Color12Bit, Gray8Bit, BlackWhite
TiffSettings.Dpi Int Resolution of the TIFF files