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 |
Order in which actions are processed by an executing job |
|
AuthorTemplate |
Template for the Author field. This may contain tokens. |
|
FileNameTemplate |
Template of which the filename will be created. This may contain Tokens. |
|
Guid |
GUID of the profile |
|
KeywordTemplate |
Template for the Keyword field. This may contain tokens. |
|
Name |
Name of the profile |
|
OutputFormat |
Default format for this print job. Valid values: Pdf, PdfA1B, PdfA2B, PdfA3B, PdfX, Jpeg, Png, Tif, Txt |
|
SaveFileTemporary |
Enable to save files only in a temp directory |
|
ShowAllNotifications |
Show a notification after converting the document |
|
ShowOnlyErrorNotifications |
Only show notification for error |
|
ShowProgress |
If true, a progress window will be shown during conversion |
|
ShowQuickActions |
Show quick actions page after converting the document |
|
SubjectTemplate |
Template for the Subject field. This may contain tokens. |
|
TargetDirectory |
Directory in which the files will be saved (in interactive mode, this is the default location that is presented to the user) |
|
TitleTemplate |
Template for the Title field. This may contain tokens. |
|
AttachmentPage |
||
Appends one or more pages at the end of the converted document |
||
AttachmentPage.Enabled |
Enables the AttachmentPage action |
|
AttachmentPage.Files |
Filename of the PDF that will be appended |
|
BackgroundPage |
||
Adds a page background to the resulting document |
||
BackgroundPage.Enabled |
Enables the BackgroundPage action |
|
BackgroundPage.File |
Filename of the PDF that will be used as background |
|
BackgroundPage.FitToPage |
Enable to resize the background to fit the document page |
|
BackgroundPage.Opacity |
Opacity for background in percent |
|
BackgroundPage.Repetition |
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 |
Enables the CoverPage action |
|
CoverPage.Files |
Filename of the PDF that will be inserted |
|
CustomScript |
||
Pre- and post-conversion actions calling functions from a custom script |
||
CustomScript.Enabled |
Enables the custom script pre- and post-conversion action |
|
CustomScript.ScriptFilename |
Filename of the custom script in application directory ‘Cs-Scripts’ folder |
|
DropboxSettings |
||
Dropbox settings for currently logged user |
||
DropboxSettings.AccountId |
ID of the linked account |
|
DropboxSettings.CreateShareLink |
||
DropboxSettings.Enabled |
||
DropboxSettings.EnsureUniqueFilenames |
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 |
||
EmailClientSettings |
||
Opens the default e-mail client with the converted document as attachment |
||
EmailClientSettings.AddSignature |
Add the PDFCreator signature to the mail |
|
EmailClientSettings.AdditionalAttachments |
The list of additional attachments for the e-mail |
|
EmailClientSettings.Content |
Body text of the e-mail |
|
EmailClientSettings.Enabled |
Enables the EmailClient action |
|
EmailClientSettings.Html |
Use html for e-mail body |
|
EmailClientSettings.Recipients |
The list of recipients of the e-mail, i.e. info@someone.com; me@mywebsite.org |
|
EmailClientSettings.RecipientsBcc |
The list of recipients of the e-mail in the ‘BCC’ field, i.e. info@someone.com; me@mywebsite.org |
|
EmailClientSettings.RecipientsCc |
The list of recipients of the e-mail in the ‘CC’ field, i.e. info@someone.com; me@mywebsite.org |
|
EmailClientSettings.Subject |
Subject line of the e-mail |
|
EmailSmtpSettings |
||
Sends a mail without user interaction through SMTP |
||
EmailSmtpSettings.AccountId |
ID of linked account |
|
EmailSmtpSettings.AddSignature |
Add the PDFCreator signature to the mail |
|
EmailSmtpSettings.AdditionalAttachments |
The list of additional attachments for the e-mail |
|
EmailSmtpSettings.Content |
Body text of the mail |
|
EmailSmtpSettings.Enabled |
If true, this action will be executed |
|
EmailSmtpSettings.Html |
Use html for e-mail body |
|
EmailSmtpSettings.Recipients |
The list of recipients of the e-mail, i.e. info@someone.com; me@mywebsite.org |
|
EmailSmtpSettings.RecipientsBcc |
The list of recipients of the e-mail in the ‘BCC’ field, i.e. info@someone.com; me@mywebsite.org |
|
EmailSmtpSettings.RecipientsCc |
The list of recipients of the e-mail in the ‘CC’ field, i.e. info@someone.com; me@mywebsite.org |
|
EmailSmtpSettings.Subject |
Subject line of the e-mail |
|
ForwardToFurtherProfile |
||
ForwardToFurtherProfile.Enabled |
||
ForwardToFurtherProfile.ProfileGuid |
||
Ftp |
||
Upload the converted documents with FTP |
||
Ftp.AccountId |
ID of the linked account |
|
Ftp.Directory |
Target directory on the server |
|
Ftp.Enabled |
If true, this action will be executed |
|
Ftp.EnsureUniqueFilenames |
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 |
These parameters will be provided to Ghostscript in addition to the PDFCreator parameters |
|
HttpSettings |
||
Action to upload files to a HTTP server |
||
HttpSettings.AccountId |
||
HttpSettings.Enabled |
If true, this action will be executed |
|
JpegSettings |
||
Settings for the JPEG output format |
||
JpegSettings.Color |
Number of colors. Valid values: Color24Bit, Gray8Bit |
|
JpegSettings.Dpi |
Resolution of the JPEG files |
|
JpegSettings.Quality |
Quality factor of the resulting JPEG (100 is best, 0 is worst) |
|
PdfSettings |
||
Settings for the PDF output format |
||
PdfSettings.ColorModel |
Color model of the PDF (does not apply to images). Valid values: Rgb, Cmyk, Gray |
|
PdfSettings.DocumentView |
Defines which controls will be opened in the reader. Valid values: NoOutLineNoThumbnailImages, Outline, ThumbnailImages, FullScreen, ContentGroupPanel, AttachmentsPanel |
|
PdfSettings.EnablePdfAValidation |
Enable PDF/A validation |
|
PdfSettings.NoFonts |
If enabled, no fonts will be embedded into the output. |
|
PdfSettings.PageOrientation |
Define how pages are automatically rotated. Valid values: Automatic, Portrait, Landscape |
|
PdfSettings.PageView |
Defines how the document will be opened in the reader. Valid values: OnePage, OneColumn, TwoColumnsOddLeft, TwoColumnsOddRight, TwoPagesOddLeft, TwoPagesOddRight |
|
PdfSettings.ViewerStartsOnPage |
Defines the page number the viewer will start on when opening the document |
|
CompressColorAndGray |
||
Compression settings for color and greyscale images |
||
PdfSettings.CompressColorAndGray.Compression |
Settings for the compression method. Valid values: Automatic, JpegMaximum, JpegHigh, JpegMedium, JpegLow, JpegMinimum, JpegManual, Zip |
|
PdfSettings.CompressColorAndGray.Dpi |
Images will be resampled to this maximum resolution of the images, if resampling is enabled |
|
PdfSettings.CompressColorAndGray.Enabled |
If true, color and grayscale images will be processed according to the algorithm. If false, they will remain uncompressed |
|
PdfSettings.CompressColorAndGray.JpegCompressionFactor |
Define a custom compression factor (requires JpegManual as method) |
|
PdfSettings.CompressColorAndGray.Resampling |
If true, the images will be resampled to a maximum resolution |
|
CompressMonochrome |
||
Compression settings for monochrome images |
||
PdfSettings.CompressMonochrome.Compression |
Settings for the compression method. Valid values: CcittFaxEncoding, Zip, RunLengthEncoding |
|
PdfSettings.CompressMonochrome.Dpi |
Images will be resampled to this maximum resolution of the images, if resampling is enabled |
|
PdfSettings.CompressMonochrome.Enabled |
If true, monochrome images will be processed according to the algorithm. If false, they will remain uncompressed |
|
PdfSettings.CompressMonochrome.Resampling |
If true, the images will be resampled to a maximum resolution |
|
Security |
||
PDF Security options |
||
PdfSettings.Security.AllowPrinting |
Allow to user to print the document |
|
PdfSettings.Security.AllowScreenReader |
Allow to user to use a screen reader |
|
PdfSettings.Security.AllowToCopyContent |
Allow to user to copy content from the PDF |
|
PdfSettings.Security.AllowToEditAssembly |
Allow to user to make changes to the assembly |
|
PdfSettings.Security.AllowToEditComments |
Allow to user to edit comments |
|
PdfSettings.Security.AllowToEditTheDocument |
Allow to user to edit the document |
|
PdfSettings.Security.AllowToFillForms |
Allow to user to fill in forms |
|
PdfSettings.Security.Enabled |
If true, the PDF file will be password protected |
|
PdfSettings.Security.EncryptionLevel |
Defines the encryption level. Valid values: Rc40Bit, Rc128Bit, Aes128Bit, Aes256Bit |
|
PdfSettings.Security.OwnerPassword |
Password that can be used to modify the document |
|
PdfSettings.Security.RequireUserPassword |
If true, a password is required to open the document. |
|
PdfSettings.Security.RestrictPrintingToLowQuality |
If true, only printing in low resolution will be supported |
|
PdfSettings.Security.UserPassword |
Password that must be used to open the document (if set) |
|
Signature |
||
Digitally sign the PDF document |
||
PdfSettings.Signature.AllowMultiSigning |
If true, the PDF file may be signed by additional persons |
|
PdfSettings.Signature.CertificateFile |
Path to the certificate |
|
PdfSettings.Signature.DisplaySignatureInDocument |
If true, the signature will be displayed in the PDF file |
|
PdfSettings.Signature.Enabled |
If true, the signature will be displayed in the PDF document |
|
PdfSettings.Signature.LeftX |
Signature location: Top left corner (X part) |
|
PdfSettings.Signature.LeftY |
Signature location: Top left corner (Y part) |
|
PdfSettings.Signature.RightX |
Signature location: Bottom right corner (X part) |
|
PdfSettings.Signature.RightY |
Signature location: Bottom right corner (Y part) |
|
PdfSettings.Signature.SignContact |
Contact name of the signature |
|
PdfSettings.Signature.SignLocation |
Signature location |
|
PdfSettings.Signature.SignReason |
Reason for the signature |
|
PdfSettings.Signature.SignatureCustomPage |
If the signature page is set to custom, this property defines the page where the signature will be displayed |
|
PdfSettings.Signature.SignaturePage |
Defines the page on which the signature will be displayed. Valid values: FirstPage, LastPage, CustomPage |
|
PdfSettings.Signature.SignaturePassword |
Password for the certificate file |
|
PdfSettings.Signature.TimeServerAccountId |
ID of the linked account for the timeserver |
|
PngSettings |
||
Settings for the PNG output format |
||
PngSettings.Color |
Number of colors. Valid values: Color32BitTransp, Color24Bit, Color8Bit, Color4Bit, Gray8Bit, BlackWhite |
|
PngSettings.Dpi |
Resolution of the PNG files |
|
Printing |
||
Print the document to a physical printer |
||
Printing.Duplex |
Defines the duplex printing mode. Valid values: Disable, LongEdge, ShortEdge |
|
Printing.Enabled |
If enabled, the document will be printed to a physical printer |
|
Printing.PrinterName |
Name of the printer that will be used, if SelectedPrinter is set. |
|
Printing.SelectPrinter |
Method to select the printer. Valid values: DefaultPrinter, ShowDialog, SelectedPrinter |
|
Scripting |
||
The scripting action allows to run a script after the conversion |
||
Scripting.Enabled |
If true, the given script or application will be executed |
|
Scripting.ParameterString |
Parameters that will be passed to the script in addition to the output files |
|
Scripting.ScriptFile |
Path to the script or application |
|
Scripting.Visible |
If false, the given script or application will be executed in a hidden window |
|
Scripting.WaitForScript |
Wait until the script execution has ended |
|
Stamping |
||
Place a stamp text on all pages of the document |
||
Stamping.Color |
Color of the text |
|
Stamping.Enabled |
If true, the document all pages will be stamped with a text |
|
Stamping.FontAsOutline |
If true, the text will be rendered as outline. If false, it will be filled. |
|
Stamping.FontFile |
PostScript name of the stamp font. |
|
Stamping.FontName |
Name of the font. (this is only used as a hint, the PostScriptFontName contains the real name) |
|
Stamping.FontOutlineWidth |
Width of the outline |
|
Stamping.FontSize |
Size of the font |
|
Stamping.StampText |
Text that will be stamped |
|
TextSettings |
||
TextSettings.Format |
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 |
Number of colors. Valid values: Color24Bit, Color12Bit, Gray8Bit, BlackWhiteG3Fax, BlackWhiteG4Fax, BlackWhiteLzw |
|
TiffSettings.Dpi |
Resolution of the TIFF files |
|
UserTokens |
||
Parse ps files for user defined tokens |
||
UserTokens.Enabled |
Activate parsing ps files for user tokens (Only available in the PDFCreator business editions) |
|
UserTokens.Seperator |
UserToken separator in the document Valid values: SquareBrackets, AngleBrackets, |
|
Watermark |
||
Adds a watermark to the resulting document |
||
Watermark.Enabled |
Enables the WatermarkAction |
|
Watermark.File |
Filename of the PDF that will be used as watermark |
|
Watermark.FitToPage |
Enable to resize the watermark to fit the document page |
|
Watermark.Opacity |
Opacity for watermark in percent |
|
Watermark.Repetition |
Defines the way the watermark document is repeated Valid values: NoRepetition, RepeatAllPages, RepeatLastPage |