SetEmbeddedFileAFRelationship

PDF/UA & Accesibilitate

Descriere

Setează cheia AFRelationship în dicționarul de specificație de fișier al unui fișier încorporat. Cerută de ISO 14289-1 (PDF/UA-1) §7.11 când fișiere încorporate sunt incluse într-un document PDF accesibil

Sintaxă

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

Parametri

IndexIndexul fișierului încorporat, numerotat de la 0. Interval valid: 0 până la EmbeddedFileCount - 1
AFRelationshipRelația fișierului încorporat cu documentul. Trebuie să fie una dintre următoarele valori, care fac distincție între majuscule și minuscule:

Source — fișierul încorporat este fișierul sursă folosit la crearea documentului
Data — fișierul încorporat conține date folosite de document
Alternative — fișierul încorporat este o reprezentare alternativă a conținutului documentului
Supplement — fișierul încorporat este suplimentar documentului
Unspecified — relația nu este specificată (implicit când SetPDFUAMode este activ)

Valoare returnată

Returnează 1 în caz de succes. Returnează 0 dacă indexul este în afara intervalului, valoarea AFRelationship nu este una dintre cele cinci valori valide sau niciun document nu este deschis

Observații

Când SetPDFUAMode este activ, PDF Library for Delphi setează automat AFRelationship pe Unspecified pentru orice fișier încorporat care nu are deja cheia. Folosiți SetEmbeddedFileAFRelationship înainte de salvare pentru a suprascrie acest implicit cu o valoare de relație mai specifică

Apelați această funcție după adăugarea fișierului încorporat și înainte de salvarea documentului

Exemplu

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

Consultați și

SetPDFUAMode, SetPDFAMode, AddFileAttachment, AddEmbeddedFile, EmbedFile, SetEmbeddedFileStrProperty