abstract DocumentPdf
Definiert in: sdk/cosmolink.SDK.Document.ts:2449
Enthält eine Funktionssammlung für PDF-Aktionen
Methoden
addAttachments()
static addAttachments(filePath, attachments): void;
Definiert in: sdk/cosmolink.SDK.Document.ts:2958
Fügt einen Anhang zu einem PDF-Dokument hinzu.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Das PDF Dokument |
attachments | string[] | Ein Array mit den Dateipfaden anzuhängenden Dateien. |
Rückgabewert
void
addAttachmentsExtended()
static addAttachmentsExtended(filePath, attachments): void;
Definiert in: sdk/cosmolink.SDK.Document.ts:2969
Fügt einen Anhang zu einem PDF-Dokument hinzu.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Das PDF Dokument |
attachments | IPdfAttachment[] | Ein Array mit den Anhängen |
Rückgabewert
void
attachZugferdInvoice()
static attachZugferdInvoice(filePath, options?): void;
Definiert in: sdk/cosmolink.SDK.Document.ts:3032
Fügt eine ZUGFeRD XML Datei an ein PDF-Dokument hinzu.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die PDF Datei |
options? | { conformanceLevel: PdfZugferdConformanceLevel; version?: PdfZugferdVersion; xmlPath: string; } | Optionen |
options.conformanceLevel? | PdfZugferdConformanceLevel | Das Konformitätslevel des Zugferd-Dokuments |
options.version? | PdfZugferdVersion | Die Version des Zugferd-Dokuments |
options.xmlPath? | string | Der Pfad zur XML-Datei, die dem PDF-Dokument zugeordnet werden soll |
Rückgabewert
void
changeEncryption()
static changeEncryption(
filePath,
oldOptions?,
newOptions?): void;
Definiert in: sdk/cosmolink.SDK.Document.ts:2841
Ändert die Verschlüsselung eines PDF-Dokuments.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die zu ändernde Datei |
oldOptions? | { dataExtractionPermissions?: PdfDocumentDataExtractionPermissions; encryptionAlgorithm?: PdfEncryptionAlgorithm; interactivityPermissions?: PdfDocumentInteractivityPermissions; modificationPermissions?: PdfDocumentModificationPermissions; ownerPassword?: string; printingPermissions?: PdfDocumentPrintingPermissions; userPassword?: string; } | Die alten Verschlüsselungsoptionen |
oldOptions.dataExtractionPermissions? | PdfDocumentDataExtractionPermissions | Gibt an, ob Daten aus dem PDF extrahiert werden dürfen |
oldOptions.encryptionAlgorithm? | PdfEncryptionAlgorithm | Der für die Verschlüsselung zu verwendende Algorithmus |
oldOptions.interactivityPermissions? | PdfDocumentInteractivityPermissions | Gibt an, ob das Dokument interaktive Operationen gestattet. |
oldOptions.modificationPermissions? | PdfDocumentModificationPermissions | Gibt an, ob das Dokument bearbeitet werden darf |
oldOptions.ownerPassword? | string | Das Eigentümer Password um das Dokument mit allen Zugriffsrechten zu öffnen |
oldOptions.printingPermissions? | PdfDocumentPrintingPermissions | Gibt an, ob das Dokument gedruckt werden darf |
oldOptions.userPassword? | string | Das Benutzer Password um das Dokument beim öffnen zu sichern |
newOptions? | { dataExtractionPermissions?: PdfDocumentDataExtractionPermissions; encryptionAlgorithm?: PdfEncryptionAlgorithm; interactivityPermissions?: PdfDocumentInteractivityPermissions; modificationPermissions?: PdfDocumentModificationPermissions; ownerPassword?: string; printingPermissions?: PdfDocumentPrintingPermissions; userPassword?: string; } | Die neuen Verschlüsselungsoptionen |
newOptions.dataExtractionPermissions? | PdfDocumentDataExtractionPermissions | Gibt an, ob Daten aus dem PDF extrahiert werden dürfen |
newOptions.encryptionAlgorithm? | PdfEncryptionAlgorithm | Der für die Verschlüsselung zu verwendende Algorithmus |
newOptions.interactivityPermissions? | PdfDocumentInteractivityPermissions | Gibt an, ob das Dokument interaktive Operationen gestattet. |
newOptions.modificationPermissions? | PdfDocumentModificationPermissions | Gibt an, ob das Dokument bearbeitet werden darf |
newOptions.ownerPassword? | string | Das Eigentümer Password um das Dokument mit allen Zugriffsrechten zu öffnen |
newOptions.printingPermissions? | PdfDocumentPrintingPermissions | Gibt an, ob das Dokument gedruckt werden darf |
newOptions.userPassword? | string | Das Benutzer Password um das Dokument beim öffnen zu sichern |
Rückgabewert
void
decrypt()
static decrypt(filePath, options?): void;
Definiert in: sdk/cosmolink.SDK.Document.ts:2718
Entschlüsselt ein PDF-Dokument mit den angegebenen Optionen
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die zu entschlüsselnde Datei |
options? | { dataExtractionPermissions?: PdfDocumentDataExtractionPermissions; encryptionAlgorithm?: PdfEncryptionAlgorithm; interactivityPermissions?: PdfDocumentInteractivityPermissions; modificationPermissions?: PdfDocumentModificationPermissions; ownerPassword?: string; printingPermissions?: PdfDocumentPrintingPermissions; userPassword?: string; } | Die Entschlüsselungsoptionen |
options.dataExtractionPermissions? | PdfDocumentDataExtractionPermissions | Gibt an, ob Daten aus dem PDF extrahiert werden dürfen |
options.encryptionAlgorithm? | PdfEncryptionAlgorithm | Der für die Verschlüsselung zu verwendende Algorithmus |
options.interactivityPermissions? | PdfDocumentInteractivityPermissions | Gibt an, ob das Dokument interaktive Operationen gestattet. |
options.modificationPermissions? | PdfDocumentModificationPermissions | Gibt an, ob das Dokument bearbeitet werden darf |
options.ownerPassword? | string | Das Eigentümer Password um das Dokument mit allen Zugriffsrechten zu öffnen |
options.printingPermissions? | PdfDocumentPrintingPermissions | Gibt an, ob das Dokument gedruckt werden darf |
options.userPassword? | string | Das Benutzer Password um das Dokument beim öffnen zu sichern |
Rückgabewert
void
encrypt()
static encrypt(filePath, options?): void;
Definiert in: sdk/cosmolink.SDK.Document.ts:2779
Verschlüsselt ein PDF-Dokument mit den angegebenen Optionen
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die zu verschlüsselnde Datei |
options? | { dataExtractionPermissions?: PdfDocumentDataExtractionPermissions; encryptionAlgorithm?: PdfEncryptionAlgorithm; interactivityPermissions?: PdfDocumentInteractivityPermissions; modificationPermissions?: PdfDocumentModificationPermissions; ownerPassword?: string; printingPermissions?: PdfDocumentPrintingPermissions; userPassword?: string; } | Die Verschlüsselungsoptionen |
options.dataExtractionPermissions? | PdfDocumentDataExtractionPermissions | Gibt an, ob Daten aus dem PDF extrahiert werden dürfen |
options.encryptionAlgorithm? | PdfEncryptionAlgorithm | Der für die Verschlüsselung zu verwendende Algorithmus |
options.interactivityPermissions? | PdfDocumentInteractivityPermissions | Gibt an, ob das Dokument interaktive Operationen gestattet. |
options.modificationPermissions? | PdfDocumentModificationPermissions | Gibt an, ob das Dokument bearbeitet werden darf |
options.ownerPassword? | string | Das Eigentümer Password um das Dokument mit allen Zugriffsrechten zu öffnen |
options.printingPermissions? | PdfDocumentPrintingPermissions | Gibt an, ob das Dokument gedruckt werden darf |
options.userPassword? | string | Das Benutzer Password um das Dokument beim öffnen zu sichern |
Rückgabewert
void
getAttachments()
static getAttachments(filePath): PdfAttachment[];
Definiert in: sdk/cosmolink.SDK.Document.ts:2947
Liefert die Anhänge eines PDF-Dokuments zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string |
Rückgabewert
getImages()
static getImages(filePath, page?): Uint8Array<ArrayBufferLike>[];
Definiert in: sdk/cosmolink.SDK.Document.ts:3069
Liefert die Bilder eines PDF-Dokuments als byte Array zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Das PDF-Dokument |
page? | number | Die PDF Seite der gesuchten Bilder. Bei -1 werden alle Seiten zurückgegeben. |
Rückgabewert
Uint8Array<ArrayBufferLike>[]
getMetadata()
static getMetadata(filePath): string;
Definiert in: sdk/cosmolink.SDK.Document.ts:2990
Liefert die Metadaten eines PDF zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die Datei, deren Metadaten abgerufen werden sollen |
Rückgabewert
string
getPageCount()
static getPageCount(filePath): number;
Definiert in: sdk/cosmolink.SDK.Document.ts:3021
Liefert die Seitenanzahl eines PDF-Dokuments zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die PDF-Datei |
Rückgabewert
number
getText()
static getText(filePath): string;
Definiert in: sdk/cosmolink.SDK.Document.ts:3011
Liefert den Text eines PDF-Dokuments zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die PDF Datei |
Rückgabewert
string
merge()
static merge(targetFile, filesToMerge): void;
Definiert in: sdk/cosmolink.SDK.Document.ts:3095
Führt mehrere PDF-Dateien zu einer einzigen PDF-Datei zusammen.
Parameter
| Parameter | Type | Description |
|---|---|---|
targetFile | string | Der Dateipfad der zusammengeführten PDF-Datei. Ist die Datei bereits vorhanden, werden die in filesToMerge angegebenen Dateien angehangen. Ist die Datei nicht vorhanden, wird eine neue Datei erzeugt. |
filesToMerge | string[] | Ein Array von Dateipfaden der PDF-Dateien, die zusammengeführt werden sollen. |
Rückgabewert
void
Throws
ArgumentNullException - Wird ausgelöst, wenn der Dateipfad der zusammengeführten Datei oder einer der Quelldateipfade leer ist.
Throws
FileNotFoundException - Wird ausgelöst, wenn eine der Quelldateien nicht existiert.
Throws
Exception - Wird ausgelöst, wenn weniger als zwei Dateien zum Zusammenführen angegeben werden oder eine der Quelldateien keine PDF-Datei ist.
print()
static print(filePath, options?): void;
Definiert in: sdk/cosmolink.SDK.Document.ts:2474
Druckt das übergebene Dokument mit den angegebenen Druckeinstellungen
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Das zu druckende Dokument |
options? | { collate?: boolean; copies?: number; duplex?: Duplex; fallbackToDefault?: boolean; fromPage?: number; outputFilePath?: boolean; pdfPrintSettings?: { detachStreamAfterLoadComplete?: boolean; ignorePDFSecuritySettings?: boolean; pageOrientation?: PdfPrintPageOrientation; password?: string; scale?: number; scaleMode?: PdfPrintScaleMode; }; printerName?: string; printToFile?: boolean; showPrintDialog?: boolean; textFilePrintSettings?: { fontName?: string; fontSize?: number; }; toPage?: number; waitForCompletion?: boolean; wordPrintSettings?: { documentFormat?: DocumentFormatWord; password?: string; }; workbookPrintSettings?: { autoPageBreaks?: boolean; blackAndWhite?: boolean; documentFormat?: DocumentFormatExcel; fitToHeight?: number; fitToPage?: boolean; fitToWidth?: number; pageOrientation?: WorkbookPrintPageOrientation; password?: string; printGridlines?: boolean; printHeadings?: boolean; scale?: number; }; } | Optionen |
options.collate? | boolean | Gibt an, ob die Seiten sortiert werden sollen |
options.copies? | number | Gibt die Anzahl der Kopien an. |
options.duplex? | Duplex | Gibt an, welcher Duplex Druckmodus verwendet werden soll |
options.fallbackToDefault? | boolean | Gibt an ob auf den Standarddrucker zurückgegriffen werden soll, falls der angegebene Drucker nicht verfügbar ist |
options.fromPage? | number | Die erste zu druckende Seite |
options.outputFilePath? | boolean | Der Dateipfad, in der die Dateiausgabe erfolgen soll |
options.pdfPrintSettings? | { detachStreamAfterLoadComplete?: boolean; ignorePDFSecuritySettings?: boolean; pageOrientation?: PdfPrintPageOrientation; password?: string; scale?: number; scaleMode?: PdfPrintScaleMode; } | Einstellungen für den PDF Druck |
options.pdfPrintSettings.detachStreamAfterLoadComplete? | boolean | Gibt an ob der System.IO.Stream nach dem Laden abgekoppelt wird. |
options.pdfPrintSettings.ignorePDFSecuritySettings? | boolean | Gibt an, ob die Sicherheitseinstellungen eines PDF Dokumentes ignoriert werden sollen |
options.pdfPrintSettings.pageOrientation? | PdfPrintPageOrientation | Gibt die Ausrichtung der Seiten der PDF an. |
options.pdfPrintSettings.password? | string | Das Passwort um auf das Dokument zugreifen zu können, sollte dieses durch eines geschützt sein |
options.pdfPrintSettings.scale? | number | Gibt einen prozentualen Wert für den Faktor der Skalierung an. |
options.pdfPrintSettings.scaleMode? | PdfPrintScaleMode | Gibt den Skalierungsmodus der PDF Seiten an. |
options.printerName? | string | Gibt den Namen des Druckers an, auf dem die Ausgabe erfolgen soll |
options.printToFile? | boolean | Gibt an, ob die Ausgabe in eine Datei erfolgen soll anstelle eines Druckers |
options.showPrintDialog? | boolean | Gibt an, ob ein Druckdialog angezeigt werden soll |
options.textFilePrintSettings? | { fontName?: string; fontSize?: number; } | Einstellungen für den Text Dateien Druck |
options.textFilePrintSettings.fontName? | string | Der Name der Schriftart, die für den Text verwendet werden soll. |
options.textFilePrintSettings.fontSize? | number | Die Größe der Schriftart, die für den Text verwendet werden soll. |
options.toPage? | number | Die letzte zu druckende Seite |
options.waitForCompletion? | boolean | Gibt an ob auf den Abschluss des Druckvorgang gewartet werden soll |
options.wordPrintSettings? | { documentFormat?: DocumentFormatWord; password?: string; } | Einstellungen für den Word Dateien Druck |
options.wordPrintSettings.documentFormat? | DocumentFormatWord | Gibt die das Format des Dokumentes an |
options.wordPrintSettings.password? | string | Das Passwort um auf das Dokument zugreifen zu können, sollte dieses durch eines geschützt sein |
options.workbookPrintSettings? | { autoPageBreaks?: boolean; blackAndWhite?: boolean; documentFormat?: DocumentFormatExcel; fitToHeight?: number; fitToPage?: boolean; fitToWidth?: number; pageOrientation?: WorkbookPrintPageOrientation; password?: string; printGridlines?: boolean; printHeadings?: boolean; scale?: number; } | Einstellungen für den Excel Dateien Druck |
options.workbookPrintSettings.autoPageBreaks? | boolean | Gibt an, ob Seitenumbrüche automatisch erzeugt werden. |
options.workbookPrintSettings.blackAndWhite? | boolean | Gibt an, ob das Dokument in Schwarz und Weiß oder in Farbe gedruckt wird. |
options.workbookPrintSettings.documentFormat? | DocumentFormatExcel | Gibt die das Format des Dokumentes an |
options.workbookPrintSettings.fitToHeight? | number | Gibt die Anzahl an vertikalen Seiten an, auf die die Inhalte der Datei passen müssen. Wird nur angewendet wenn fitToPage auf true gesetzt wurde. |
options.workbookPrintSettings.fitToPage? | boolean | Gibt an, ob der Inhalt der Datei auf einer angegebene Anzahl an Seiten dargestellt werden soll true wenn die Inhalte auf der angebenen Anzahl an Seiten dargestellt werden sollen; andernfalls, false . |
options.workbookPrintSettings.fitToWidth? | number | Gibt die Anzahl an horizontalen Seiten an, auf die die Inhalte der Datei passen müssen. Wird nur angewendet wenn fitToPage auf true gesetzt wurde. |
options.workbookPrintSettings.pageOrientation? | WorkbookPrintPageOrientation | Gibt das Seitenformat an |
options.workbookPrintSettings.password? | string | Das Passwort um auf das Dokument zugreifen zu können, sollte dieses durch eines geschützt sein |
options.workbookPrintSettings.printGridlines? | boolean | Gibt an, ob die Gridlinien mit aufgedruckt werden sollen. |
options.workbookPrintSettings.printHeadings? | boolean | Gibt an, ob die Namen der Spalten und Reihen gedruckt werden. |
options.workbookPrintSettings.scale? | number | Gibt einen prozentualen Wert für den Faktor der Skalierung an. |
Rückgabewert
void
removeAttachment()
static removeAttachment(filePath, index): boolean;
Definiert in: sdk/cosmolink.SDK.Document.ts:2980
Entfernt einen Anhang aus einem PDF-Dokument.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Das PDF Dokument |
index | number | Der Index des Anhangs |
Rückgabewert
boolean
setMetadata()
static setMetadata(filePath, metadata): void;
Definiert in: sdk/cosmolink.SDK.Document.ts:3001
Setzt die Metadaten eines PDF-Dokuments.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Die Datei, deren Metadaten gesetzt werden sollen |
metadata | string | Die Metadaten |
Rückgabewert
void