SetEmbeddedFileAFRelationship

PDF/UA & tilgængelighed

Beskrivelse

Indstiller nøglen AFRelationship på filspecifikationsordbogen for en integreret fil. Kræves af ISO 14289-1 (PDF/UA-1) §7.11, når integrerede filer medtages i et tilgængeligt PDF-dokument.

Syntaks

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

Index	1-baseret indeks for den indlejrede fil. Gyldigt interval: 1 til EmbeddedFileCount
AFRelationship	Den indlejrede fils relation til dokumentet. Skal være en af følgende værdier med forskel på store og små bogstaver: Source — den indlejrede fil er kildefilen, som blev brugt til at oprette dokumentet Data — den indlejrede fil indeholder data, som dokumentet bruger Alternative — den indlejrede fil er en alternativ repræsentation af dokumentindholdet Supplement — den indlejrede fil supplerer dokumentet Unspecified — relationen er ikke angivet (standard, når SetPDFUAMode er aktiv)

Index

1-baseret indeks for den indlejrede fil. Gyldigt interval: 1 til EmbeddedFileCount

AFRelationship

Den indlejrede fils relation til dokumentet. Skal være en af følgende værdier med forskel på store og små bogstaver:

Source — den indlejrede fil er kildefilen, som blev brugt til at oprette dokumentet
Data — den indlejrede fil indeholder data, som dokumentet bruger
Alternative — den indlejrede fil er en alternativ repræsentation af dokumentindholdet
Supplement — den indlejrede fil supplerer dokumentet
Unspecified — relationen er ikke angivet (standard, når SetPDFUAMode er aktiv)

Returværdi

Returnerer 1 ved succes. Returnerer 0, hvis indekset ligger uden for området, værdien AFRelationship ikke er en af de fem gyldige værdier, eller intet dokument er åbent.

Bemærkninger

Når SetPDFUAMode er aktiv, indstiller PDF Library for Delphi automatisk AFRelationship til Unspecified for enhver integreret fil, som ikke allerede har nøglen. Brug SetEmbeddedFileAFRelationship før lagring for at tilsidesætte denne standard med en mere specifik relationsværdi

Kald denne funktion, efter at den integrerede fil er tilføjet, og før dokumentet gemmes.

Eksempel

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

Se også

SetPDFUAMode, SetPDFAMode, AddFileAttachment, AddEmbeddedFile, EmbedFile, SetEmbeddedFileStrProperty