SetEmbeddedFileAFRelationship

PDF/UA en toegankelijkheid

Beschrijving

Zet de sleutel AFRelationship op de filespecificatie-woordenboek van een ingesloten bestand. Vereist door ISO 14289-1 (PDF/UA-1) §7.11 wanneer ingesloten bestanden in een toegankelijk PDF-document zitten

Syntaxis

Delphi

Function TPDFlib.SetEmbeddedFileAFRelationship(Index: Integer; Const AFRelationship: WideString): Integer;

ActiveX

Function PDFlib::SetEmbeddedFileAFRelationship(Index As Long, AFRelationship As String) As Long

DLL

int DLSetEmbeddedFileAFRelationship(int InstanceID, int Index, const wchar_t * AFRelationship);

Parameters

Index	Zero-based index van het ingesloten bestand. Geldig bereik: 0 tot EmbeddedFileCount - 1
AFRelationship	De relatie van het ingesloten bestand tot het document. Dit moet een van de volgende hoofdlettergevoelige waarden zijn: Source — het ingesloten bestand is het bronbestand waarmee het document is gemaakt Data — het ingesloten bestand bevat data die het document gebruikt Alternative — het ingesloten bestand is een alternatieve representatie van de documentinhoud Supplement — het ingesloten bestand is aanvullend op het document Unspecified — de relatie is niet gespecificeerd (standaard wanneer SetPDFUAMode actief is)

Index

Zero-based index van het ingesloten bestand. Geldig bereik: 0 tot EmbeddedFileCount - 1

AFRelationship

De relatie van het ingesloten bestand tot het document. Dit moet een van de volgende hoofdlettergevoelige waarden zijn:

Source — het ingesloten bestand is het bronbestand waarmee het document is gemaakt
Data — het ingesloten bestand bevat data die het document gebruikt
Alternative — het ingesloten bestand is een alternatieve representatie van de documentinhoud
Supplement — het ingesloten bestand is aanvullend op het document
Unspecified — de relatie is niet gespecificeerd (standaard wanneer SetPDFUAMode actief is)

Retourwaarde

Geeft 1 terug bij succes. Geeft 0 terug als de index buiten bereik is, de AFRelationship-waarde niet een van de vijf geldige waarden is, of er geen document open is

Opmerkingen

Wanneer SetPDFUAMode actief is, zet PDF Library for Delphi AFRelationship automatisch op Unspecified voor elk ingesloten bestand dat de sleutel nog niet heeft. Gebruik SetEmbeddedFileAFRelationship vóór het opslaan om deze standaard te overstijgen met een specifiekere relantiewaarde

Roep deze functie aan na het toevoegen van het ingesloten bestand en vóór het opslaan van het document

Voorbeeld

// 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;

Zie ook

SetPDFUAMode, SetPDFAMode, AddFileAttachment, AddEmbeddedFile, EmbedFile, SetEmbeddedFileStrProperty