Setting | Type | Description |
---|---|---|
AuthorTemplate | String | Template for the Author field. This maycontain tokens. |
FileNameTemplate | String | Template of which the filename will becreated. This may contain Tokens. |
Guid | String | GUID of the profile |
KeywordTemplate | String | Template for the Keyword field. This maycontain tokens. |
Name | String | Name of the profile |
OpenViewer | Bool | Open the default viewer after converting thedocument |
OpenWithPdfArchitect | Bool | If the output is a PDF, use PDF Architectinstead of the default PDF viewer |
OutputFormat | Enum | Default format for this print job. Validvalues: Pdf, PdfA1B, PdfA2B, PdfX, Jpeg,Png, Tif, Txt |
ShowAllNotifications | Bool | Show a notification after converting thedocument |
ShowOnlyErrorNotifications | Bool | Only show notification for error |
ShowProgress | Bool | If true, a progress window will be shownduring conversion |
ShowQuickActions | Bool | Show quick actions page after converting thedocument |
SkipPrintDialog | Bool | Allows to skip the print dialog (wheremetadata are set) and directly proceed tothe save dialog |
SubjectTemplate | String | Template for the Subject field. This maycontain tokens. |
TargetDirectory | String | Directory in which the files will be saved(in interactive mode, this is the defaultlocation that is presented to the user) |
TitleTemplate | String | Template for the Title field. This maycontain 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 asbackground |
BackgroundPage.OnAttachment | Bool | If true, the background will be placed on theattachment as well |
BackgroundPage.OnCover | Bool | If true, the background will be placed on thecover as well |
BackgroundPage.Repetition | Enum | Defines the way the background document isrepeated. 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.File | String | Filename of the PDF that will be inserted |
CustomScript | ||
Pre- and postconversion actions calling functions from a custom script | ||
CustomScript.Enabled | Bool | Enables the custom script pre- andpostconversion action |
CustomScript.ScriptFilename | String | Filename of the custom script in applicationdirectory ‘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 beoverwritten on the server. A counter willbe 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.Content | String | Body text of the e-mail |
EmailClientSettings.Enabled | Bool | Enables the EmailClient action |
EmailClientSettings.Html | Bool | Use html for e-mail body |
EmailClientSettings.Recipients | String | The list of receipients of the e-mail, i.e.info@someone.com; me@mywebsite.org |
EmailClientSettings.RecipientsBcc | String | The list of receipients of the e-mail in the‘BCC’ field, i.e. info@someone.com;me@mywebsite.org |
EmailClientSettings.RecipientsCc | String | The list of receipients 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.Content | String | Body text of the mail |
EmailSmtpSettings.Enabled | Bool | If true, this action will be executed |
EmailSmtpSettings.Html | Bool | Use html for e-mail body |
EmailSmtpSettings.Recipients | String | The list of receipients of the e-mail, i.e.info@someone.com; me@mywebsite.org |
EmailSmtpSettings.RecipientsBcc | String | The list of receipients of the e-mail in the‘BCC’ field, i.e. info@someone.com;me@mywebsite.org |
EmailSmtpSettings.RecipientsCc | String | The list of receipients of the e-mail in the‘CC’ field, i.e. info@someone.com;me@mywebsite.org |
EmailSmtpSettings.Subject | String | Subject line of the e-mail |
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 beoverwritten on the server. A counter willbe appended instead (i.e. document_2.pdf) |
Ghostscript | ||
Ghostscript settings | ||
Ghostscript.AdditionalGsParameters | String | These parameters will be provided toGhostscript in addition to the PDFCreatorparameters |
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 isbest, 0 is worst) |
PdfSettings | ||
Settings for the PDF output format | ||
PdfSettings.ColorModel | Enum | Color model of the PDF (does not apply toimages). Valid values: Rgb, Cmyk, Gray |
PdfSettings.DocumentView | Enum | Defines which controls will be opened in thereader. Valid values:NoOutLineNoThumbnailImages, Outline,ThumbnailImages, FullScreen,ContentGroupPanel, AttachmentsPanel |
PdfSettings.EnablePdfAValidation | Bool | Enable PdfAValidation |
PdfSettings.PageOrientation | Enum | Define how pages are automatically rotated.Valid values: Automatic, Portrait,Landscape |
PdfSettings.PageView | Enum | Defines how the document will be opened inthe reader. Valid values: OnePage,OneColumn, TwoColumnsOddLeft,TwoColumnsOddRight, TwoPagesOddLeft,TwoPagesOddRight |
PdfSettings.ViewerStartsOnPage | Int | Defines the page number the viewer will starton when opening the document |
CompressColorAndGray | ||
Compression settings for color and greyscale images | ||
PdfSettings.CompressColorAndGray.Compression | Enum | Settings for the compression method. Validvalues: Automatic, JpegMaximum, JpegHigh,JpegMedium, JpegLow, JpegMinimum,JpegManual, Zip |
PdfSettings.CompressColorAndGray.Dpi | Int | Images will be resampled to this maximumresolution of the images, if resampling isenabled |
PdfSettings.CompressColorAndGray.Enabled | Bool | If true, color and grayscale images will beprocessed according to the algorithm. Iffalse, they will remain uncompressed |
PdfSettings.CompressColorAndGray.JpegCompressionFactor | Double | Define a custom compression factor (requiresJpegManual as method) |
PdfSettings.CompressColorAndGray.Resampling | Bool | If true, the images will be resampled to amaximum resolution |
CompressMonochrome | ||
Compression settings for monochrome images | ||
PdfSettings.CompressMonochrome.Compression | Enum | Settings for the compression method. Validvalues: CcittFaxEncoding, Zip,RunLengthEncoding |
PdfSettings.CompressMonochrome.Dpi | Int | Images will be resampled to this maximumresolution of the images, if resampling isenabled |
PdfSettings.CompressMonochrome.Enabled | Bool | If true, monochrome images will be processedaccording to the algorithm. If false, theywill remain uncompressed |
PdfSettings.CompressMonochrome.Resampling | Bool | If true, the images will be resampled to amaximum 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 passwordprotected |
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 thedocument |
PdfSettings.Security.RequireUserPassword | Bool | If true, a password is required to open thedocument. |
PdfSettings.Security.RestrictPrintingToLowQuality | Bool | If true, only printing in low resolution willbe supported |
PdfSettings.Security.UserPassword | String | Password that must be used to open thedocument (if set) |
Signature | ||
Digitally sign the PDF document | ||
PdfSettings.Signature.AllowMultiSigning | Bool | If true, the PDF file may be signed byadditional persons |
PdfSettings.Signature.CertificateFile | String | Path to the certificate |
PdfSettings.Signature.DisplaySignatureInDocument | Bool | If true, the signature will be displayed inthe PDF file |
PdfSettings.Signature.Enabled | Bool | If true, the signature will be displayed inthe PDF document |
PdfSettings.Signature.LeftX | Int | Signature location: Top left corner (X part) |
PdfSettings.Signature.LeftY | Int | Signature location: Top left corner (Y part) |
PdfSettings.Signature.RightX | Int | Signature location: Bottom right corner (Xpart) |
PdfSettings.Signature.RightY | Int | Signature location: Bottom right corner (Ypart) |
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, thisproperty defines the page where thesignature will be displayed |
PdfSettings.Signature.SignaturePage | Enum | Defines the page on which the signature willbe 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. Validvalues: Disable, LongEdge, ShortEdge |
Printing.Enabled | Bool | If enabled, the document will be printed to aphysical printer |
Printing.PrinterName | String | Name of the printer that will be used, ifSelectedPrinter 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 willbe executed |
Scripting.ParameterString | String | Parameters that will be passed to the scriptin 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 bestamped with a text |
Stamping.FontAsOutline | Bool | If true, the text will be rendered asoutline. If false, it will be filled. |
Stamping.FontName | String | Name of the font. (this is only used as ahint, the PostScriptFontName contains thereal 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 |
TextSettings | ||
TextSettings.Format | Int | Text Format (0 outputs XML-escaped Unicodealong with information regarding the formatof the text | 1 same XML output format,but attempts similar processing to MuPDF,and will output blocks of text | 2 outputsUnicode (UCS2) text (with a Byte OrderMark) which approximates the original textlayout | 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 definied tokens | ||
UserTokens.Enabled | Bool | Activate parsing ps files for user tokens(Only available in PDFCreator Business) |
UserTokens.Seperator | Enum | UserToken seperator in the document Validvalues: SquareBrackets, AngleBrackets,CurlyBrackets, RoundBrackets |