SetEmbeddedFileAFRelationshipA

PDF/UA & Barrierefreiheit

Beschreibung

Das nachgestellte A kennzeichnet den ANSI-DLL-Einstiegspunkt (char); die ActiveX/COM-Oberfläche stellt nur die Unicode-Form bereit. Das Verhalten entspricht SetEmbeddedFileAFRelationship, und Zeichenfolgenargumente werden mit der aktuellen Codepage von SetAnsiMode interpretiert

Legt den Schlüssel AFRelationship im Dateispezifikationswörterbuch für eine eingebettete Datei fest. Gemäß ISO 14289-1 (PDF/UA-1) §7.11 erforderlich, wenn eingebettete Dateien in einem barrierefreien PDF-Dokument enthalten sind

Syntax

Delphi

Function DLSetEmbeddedFileAFRelationshipA(InstanceID, Index: Integer; AFRelationship: PAnsiChar): Integer;

DLL

int DLSetEmbeddedFileAFRelationshipA(int InstanceID, int Index, const char * AFRelationship);

Parameter

Index	Einsbasierter Index der eingebetteten Datei. Gültiger Bereich: 1 bis EmbeddedFileCount.
AFRelationship	Die Beziehung der eingebetteten Datei zum Dokument. Muss einer der folgenden Werte mit Groß-/Kleinschreibung sein: Source — die eingebettete Datei ist die zum Erstellen des Dokuments verwendete Quelldatei Data — die eingebettete Datei enthält vom Dokument verwendete Daten Alternative — die eingebettete Datei ist eine alternative Darstellung des Dokumentinhalts Supplement — die eingebettete Datei ergänzt das Dokument Unspecified — die Beziehung ist nicht angegeben (Standard, wenn SetPDFUAMode aktiv ist)

Index

Einsbasierter Index der eingebetteten Datei. Gültiger Bereich: 1 bis EmbeddedFileCount.

AFRelationship

Die Beziehung der eingebetteten Datei zum Dokument. Muss einer der folgenden Werte mit Groß-/Kleinschreibung sein:

Source — die eingebettete Datei ist die zum Erstellen des Dokuments verwendete Quelldatei
Data — die eingebettete Datei enthält vom Dokument verwendete Daten
Alternative — die eingebettete Datei ist eine alternative Darstellung des Dokumentinhalts
Supplement — die eingebettete Datei ergänzt das Dokument
Unspecified — die Beziehung ist nicht angegeben (Standard, wenn SetPDFUAMode aktiv ist)

Rückgabewert

Gibt bei Erfolg 1 zurück. Gibt 0 zurück, wenn der Index außerhalb des Bereichs liegt, der Wert AFRelationship keiner der fünf gültigen Werte ist oder kein Dokument geöffnet ist

Anmerkungen

Wenn SetPDFUAMode aktiv ist, setzt PDF Library for Delphi AFRelationship für jede eingebettete Datei ohne diesen Schlüssel automatisch auf Unspecified. Verwenden Sie vor dem Speichern SetEmbeddedFileAFRelationship, um diesen Standardwert durch einen spezifischeren Beziehungswert zu ersetzen

Rufen Sie diese Funktion nach dem Hinzufügen der eingebetteten Datei und vor dem Speichern des Dokuments auf

Beispiel

// PDF/A-3 archive that embeds an XLSX as the document's source data
var
  FileID: Integer;
begin
  PDF.SetPDFAMode(5);              // PDF/A-3b — allows arbitrary embedded files
  PDF.NewDocument;
  PDF.AddStandardFont('Helvetica');
  PDF.AddPage;
  PDF.PrintText(50, 750, 'Quarterly Sales Report');

  FileID := PDF.AddEmbeddedFile(
    'sales-Q1.xlsx',
    'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet');
  PDF.AddFileAttachment('Source spreadsheet', FileID);

  // Mark the relationship: the spreadsheet is the source of the report
  PDF.SetEmbeddedFileAFRelationship(1, 'Source');

  PDF.SaveToFile('report-PDFA3b.pdf');
end;

Siehe auch

SetPDFUAMode, SetPDFAMode, AddFileAttachment, AddEmbeddedFile, EmbedFile, SetEmbeddedFileStrProperty