API

Gesamtliste der API-Einstellungen


EinstellungenDefaultTypBeschreibung
Author
stringSetzt PDF-Dokumentinformation, Autor
CenterWindowfalseboolÖffnet den PDF-Viewer zentriert, wenn aktiviert, ansonsten wird der Standardwert verwendet
CertificateFile
stringZertifikatsdatei
CertificatePassword
stringPasswort der Zertifizikatsdatei
CertificatePasswordSetDuringCreationfalseboolBeim Erstellen der Ausgabedatei nach dem Passwort fragen
Colorspace0enumOptionen: RGB (0), CMYK (1)
ComparableModefalseboolTIFF-kompatibler Modus
CompressionFineTunefalseboolAktivieren, um die manuelle Anpassung der Komprimierungsfunktionen über die Benutzeroberfläche zu ermöglichen.
CompressionPredefined1intStandardkomprimierungsprofil. Verwenden Sie CompressionProfile, um die Komprimierungseinstellungen zu ändern.
CompressionProfile3enumOptionen: CompressionNormal (0), CompressionHigher (1), CompressionHighest (2), LossLessJPEG (3), LosslessZIP (4)
CoverFilesList
arrayString-Liste der Deckblätter
CoverFilesListEnabledfalseboolWenn aktiviert, wird CoverFilesList verwendet
DestinationDirectory
stringAusgabeverzeichnis
DestinationFilename<Documentname>.pdfstringName der Ausgabedatei
DestinationFilenameSuffix
stringDateinamenserweiterung
DestinationFilenameSuffixEnabledfalseboolWenn aktiviert, wird die Dateinamenserweiterung verwendet
DictionaryWorkSpacedictstringArbeitsverzeichnis
Direction0enumL2R (0), R2L(1)
DisplayDocTitlefalseboolDokument mit dem PDF-Viewer anzeigen
EmbedFilenamesEnabledtrueboolAktivieren Sie die Einbettung von Dateien, die in EmbeddedFilesList angegeben sind
EmbeddedFilesList
arrayListe von Dateien, die in die Ausgabe-PDF eingebettet werden
EncryptAskForPasswordEnabledfalseboolIm UI-Speicher-Workflow nach Passwort fragen
EncryptEnableAssemblingfalseboolVerschlüsselungsrechte
EncryptEnableClipboardfalseboolVerschlüsselungsrechte
EncryptEnableExtractfalseboolVerschlüsselungsrechte
EncryptEnableFormsfalsebool
EncryptEnableModifyingfalseboolVerschlüsselungsrechte
EncryptEnableNotesfalseboolVerschlüsselungsrechte
EncryptEnablePrintingfalseboolVerschlüsselungsrechte
EncryptEnhancedPdfPassword
string-
EncryptOwnerPassword
stringPDF-Besitzerpasswort
EncryptOwnerPasswordEnabledfalseboolBesitzerpasswort verwenden
EncryptPasswordsConfirmedfalsebool-
EncryptUserPassword
stringPDF-Benutzerpasswort
EncryptUserPasswordEnabledfalseboolBenutzerpasswort verwenden
ExecuteProgramAction
arrayArray von ProgramAction-Objekten: 
{"Program": "...", "Arguments": "..."}
FatturaPADestinationCode0stringFatturaPA Einstellung: Zielcode
FatturaPAPECDestinatario
stringFatturaPA Einstellung: Empfänger
FatturaPARecipientIsGovernmentfalseboolFatturaPA Einstellung: Empfänger ist Regierung
FileExistsAction0enumOptionen: save_to_auto_destination (0), replace (1) (ersetzen), append (2) (an vorhandenes Dokument anhängen), prepend (3) (vorhandenem Dokument voranstellen)
FileQuerytrueboolNach Zielverzeichnis fragen
FitWindowfalseboolPDF-Viewer Einstellung, Dokument an Fenster anpassen
FontAntialiasing2enumOptionen: Aus (0), Ein (1), Default (2)
FontsEmbedded0enumOptionen: keine (0), alle (1), ausgewählt (2), kein Standard(3)
FontsEmbeddedOrNoEmbeddedList
stringSemikolon-separierte Zeichenfolge von Schriftarten, die nicht in die PDF-Datei eingebettet werden sollen
FontsIsEmbeddedOrNoEmbeddedListfalseboolErmöglicht die Verwendung von FontsEmbeddedOrNoEmbeddedList
FooterFilesList
arrayString-Liste der Dateien im Footer
FooterFilesListEnabledfalseboolWenn aktiviert, wird FooterFilesList verwendet
ForcePaperLength297intPapierhöhe
ForcePaperSize0enumOptionen: Keine (0), Brief 8 1/2 x 11 Zoll (1), Legal 8 1/2 x 14 Zoll (5), Executive 7 1/4 x 10 1/2 Zoll (7), A0 841 x 1189 mm (255), A1 594 x 841 mm (254), A3 297 x 420 mm (8), A2 420 x 594 mm (66), A3 Extra Traverse 322 x 455 mm (68), A4 210 x 297 mm (9), A5 148 x 210 mm (11), A6 105 x 148 mm (70), B4 250 x 354 mm (12), B4 182 x 257 mm (13), Benutzerdefiniert (256)
ForcePaperWidth210intPapierbreite
FormfieldCheckboxBackColor12632256intCheckbox Hintergrundfarbe 
FormfieldCheckboxBorderColor0intCheckbox Randfarbe
FormfieldDropdownBackColor12632256intDropdown Hintergrundfarbe 
FormfieldDropdownBorderColor0intDropdown Randfarbe
FormfieldInternalCharCount1intChar count (Zeichen zählen)
FormfieldTextfieldBackColor12632256intTextfeld Hintergrundfarbe
FormfieldTextfieldBorderColor0intTextfield Randfarbe
FormfieldUseAutoTextHeightfalseboolAutomatische Höhe verwenden
FormfieldUseCheckboxBackColortrueboolvordefinierte Hintergrundfarbe für Checkboxen verwenden
FormfieldUseCheckboxBordertrueboolvordefinierte Randfarbe für Checkboxen verwenden
FormfieldUseDefaultTextMaxCharstrueboolstandardmäßige maximale Anzahl von Zeichen verwenden
FormfieldUseDefaultTextWidthtrueboolstandardmäßige maximale Textbreite verwenden
FormfieldUseDropdownBackColortrueboolvordefinierte Hintergrundfarbe für Drop-Down-Felder verwenden
FormfieldUseDropdownBorderfalseboolvordefinierte Randfarbe für Drop-Down-Felder verwenden
FormfieldUseInternalCharCountfalsebool
FormfieldUseInternalCharCountMaxCharsfalsebool
FormfieldUseTextfieldBackColortrueboolvordefinierte Hintergrundfarbe für Textfelder verwenden
FormfieldUseTextfieldBorderfalseboolvordefinierte Randfarbe für Textfelder verwenden
GraphicColorReduction0enumOptionen: None (0) (keine), Automatic (1) (automatisch)
GraphicCompressMethod0enumOptionen: None (0) (keine), AutomaticJPEG (1), AutomaticZlibJPEG (2), JPEG (3), ZlibJPEG (4)
GraphicJpegQuality75intJPEG-Qualität
GraphicResolution600intZielauflösung für Grafiken
HideMenubarfalseboolPDF-Viewer Menüleiste verstecken
HideToolbarfalseboolPDF-Viewer Toolbar verstecken
HideWindowUIfalseboolPDF-Viewer UI-Fenster verstecken
HybridOutputEnabled0enumOptionen: Hybrid_disabled (0) (deaktiviert), Hybrid_enabled (1) (aktiviert), Hybrid_ask (100) (bei Erstellung fragen)
HybridPdfSourceFilename
string
HybridPdfSourceFilenameUsed
string
HybridResourceSharingEnabledtruebool
HyperlinkBorder1enumOptionen: None (0) (keine), Underlined (1) (unterstrichen), Frame (2) (eingerahmt) DashedFrame (3) (gestrichelter Rahmen), DottedFrame (4) (gepunkteter Rahmen)
HyperlinkBorderColor0int
HyperlinkBorderWidth100int
InvoiceType1enumOptionen: zugferd1 (0), zugferd2 (1), xrechnung (2), fatturapa (3)
Keywords
string
MailBCCRecipient
string
MailCCRecipient
string
MailNotetext
string
MailRecipient
string
MailSendImmediatefalsebool
MailSubject
string
MailText
string
NonFullScreenPageMode0enumOptionen: UseNone (0), UseOutlines (1), UseThumbs (2), UseOC (3), UseAttachments (4)
OpenLayout0enumOptionen: SinglePage (0), OneColumn (1), TwoColumnLeft (2), TwoColumnRight (3), TwoPageLeft (4), TwoPageRight (5)
OpenMode0enumOptionen: UseNone (0), UseOutlines (1), UseThumbs (2), FullScreen(3)
OpenPageIndex0int
OpenSize0enumOptionen: Standard (0), Fit (1), FitH (2)
OutlineFormats{STYLE: heading 1...string
OutlineStylesheading 1string
OutlineStylesEnabledfalsebool
PageOrientation1enumOptionen: portrait (1) (Hochformat), landscape (2) (Querformat)
PaperBorder0enumOptionen: 0 pt (0), j pt (25), S pt (50), s pt (75), 1 pt (100), 1S pt (150), 2j pt (225), 3 pt (300), 4S pt (450), 6 pt (600)
PaperMarginCentertruebool
PaperMarginLeft0int
PaperMarginTop0int
PaperScaleHeight100int
PaperScaleWidth100int
PdfVersion20enumOptionen: PDF1_3 (13), PDF1_4 (14), PDF1_5 (15), PDF1_6 (16), PDF1_7 (17), PDF1_7EL3 (18), PDF1_7EL8 (19), PDF2_0 (20), PDFA_1a (100), PDFA_1b (101), PDFA_2a (102), PDFA_2b (103), PDFA_2u (104), PDFA_3a (105), PDFA_3b (106), PDFA_3u (107), PDFUA (200)
PrintDuplexType0enumOptionen: simple (0), duplexshort (1), duplexlong (2)
PrintTargetPrinter
string
PrintType0enumOptionen: printerdefault (0), printerdialog (1), printerselected (2)
SaveConversion0enumOptionen: printer (0), rtf (1)
SaveLocation1enumOptionen: last (0) (letztes Verzeichnis), documents (1) (Dokumente), predefined (2) (vordefiniert), desktop (3) (Dektop)
ShowFormfieldsfalsebool
SignContactInfo
string
SignLocation
string
SignReason
string
StampEnabledfalsebool
StampSelected
string
StartAction1int
StartProgram
string
StartProgramBefore
string
StartProgramParameters
string
StartProgramParametersBefore
string
StationeryEnabledfalsebool
StationeryUsed
string
Subject
string
TiffColorDepth1enumOptionen: Depth24 (0), Depth1 (1), Depth4 (4), Depth8 (2), Depth8Gray (3)
TiffCompress2enumOptionen: None (0), Group3 (1), Group4 (2), RLE (3), LZW (4), Jpeg (5), Packbits (6), Deflate (7)
TiffJpegQuality75int
TiffResolution150int
TiffStripSize4int
Title
string
UseEncryptEnhancedPdfPasswordfalsebool
UseHyperlinkRecognitionfalsebool
UseHyphenation1enumOptionen: Always (0) (immer), Auto (1) (es werden die im RTF-Dokument durch WORD gesetzten Definitionen für die Silbentrennung verwendet), None (2) (nie)
UseMarkupfalsebool
UseMarkupAskedfalsebool
UseSignaturefalsebool
UseTifffalseboolTIFF verwenden
UsedTimeStampServer
string
WatermarkAsBackgroundfalsebool
WatermarkEnabledfalsebool
WatermarkFilename
string
XRechnungPaymentTypeCodeTypeCode30
stringOptionen: TypeCode10 (Barzahlung), TypeCode20 (Scheck), TypeCode30 (Überweisung), TypeCode31 (nicht-SEPA-Lastschrift), TypeCode42 (Zahlung auf Bankkonto), TypeCode48 (elektronische Geldbörse), TypeCode49 (direkte Lastschrift), TypeCode57 (Dauerauftrag), TypeCode58 (SEPA-Überweisung), TypeCode59 (SEPA-Lastschrift), TypeCode97 (Report / Bilanz zwischen Partnern)
XRechnungVersion0
enumOptionen: 1.2.2 (0), 2.0 (1)
ZUGFeRDCreationMethod1enumOptionen: xml (0), markup (1)
ZUGFeRDDeleteAfterEmbeddingfalsebool
ZUGFeRDShowAfterCreationtruebool
ZUGFeRDXml
string
Zugferd1ConformanceLevel0enumOptionen: basic (0), comfort (1)
Zugferd2ConformanceLevel0enumOptionen: basic (0), comfort (1)
Zugferd2PaymentTypeCodeTypeCode30stringOptionen: TypeCode10 (Barzahlung), TypeCode20 (Scheck), TypeCode30 (Überweisung), TypeCode31 (nicht-SEPA-Lastschrift), TypeCode42 (Zahlung auf Bankkonto), TypeCode48 (elektronische Geldbörse), TypeCode49 (direkte Lastschrift), TypeCode57 (Dauerauftrag), TypeCode58 (SEPA-Überweisung), TypeCode59 (SEPA-Lastschrift), TypeCode97 (Report / Bilanz zwischen Partnern)