SetEmbeddedFileAFRelationship

PDF/UA & prístupnosť

Opis

Nastavuje kľúč AFRelationship v slovníku špecifikácie súboru pre vložený súbor. Vyžaduje to ISO 14289-1 (PDF/UA-1) §7.11, keď sú vložené súbory súčasťou prístupného dokumentu PDF.

Syntax

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

Parametre

IndexIndex vloženého súboru číslovaný od 1. Platný rozsah: 1 po EmbeddedFileCount.
AFRelationshipVzťah vloženého súboru k dokumentu. Musí to byť jedna z nasledujúcich hodnôt (rozlišuje sa veľkosť písmen):

Source — vložený súbor je zdrojový súbor použitý na vytvorenie dokumentu
Data — vložený súbor obsahuje údaje používané dokumentom
Alternative — vložený súbor je alternatívna reprezentácia obsahu dokumentu
Supplement — vložený súbor je doplnkom dokumentu
Unspecified — vzťah nie je špecifikovaný (predvolené, keď je aktívny SetPDFUAMode)

Návratová hodnota

Pri úspechu vracia 1. Vracia 0, keď je index mimo rozsahu, hodnota AFRelationship nie je jedna z piatich platných hodnôt, alebo nie je otvorený žiadny dokument.

Poznámky

Keď je aktívny SetPDFUAMode, PDF Library for Delphi automaticky nastaví AFRelationship na Unspecified pre každý vložený súbor, ktorý kľúč ešte nemá. Túto predvolenú hodnotu konkrétnejšou hodnotou vzťahu prepíšete cez SetEmbeddedFileAFRelationship pred uložením.

Túto funkciu zavolajte po pridaní vloženého súboru a pred uložením dokumentu

Príklad

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

Pozri tiež

SetPDFUAMode, SetPDFAMode, AddFileAttachment, AddEmbeddedFile, EmbedFile, SetEmbeddedFileStrProperty