SetEmbeddedFileAFRelationship

PDF/UA & tillgänglighet

Beskrivning

Sätter nyckeln AFRelationship i file specification-dictionaryn för en inbäddad fil. Krävs av ISO 14289-1 (PDF/UA-1) §7.11 när inbäddade filer ingår i ett tillgängligt PDF-dokument

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

Parametrar

Index1-baserat index för den inbäddade filen. Giltigt intervall: 1 till EmbeddedFileCount
AFRelationshipDen inbäddade filens relation till dokumentet. Måste vara ett av följande skiftlägeskänsliga värden:

Source — den inbäddade filen är källfilen som användes för att skapa dokumentet
Data — den inbäddade filen innehåller data som dokumentet använder
Alternative — den inbäddade filen är en alternativ representation av dokumentinnehållet
Supplement — den inbäddade filen är ett komplement till dokumentet
Unspecified — relationen är inte specificerad (standard när SetPDFUAMode är aktivt)

Returvärde

Returnerar 1 vid lyckat anrop. Returnerar 0 om indexet ligger utanför intervallet, AFRelationship-värdet inte är ett av de fem giltiga värdena, eller inget dokument är öppet

Anmärkningar

När SetPDFUAMode är aktivt sätter PDF Library for Delphi automatiskt AFRelationship till Unspecified för varje inbäddad fil som inte redan har nyckeln. Använd SetEmbeddedFileAFRelationship före sparning för att åsidosätta detta standardvärde med ett mer specifikt relationsvärde

Anropa den här funktionen efter att den inbäddade filen lagts till och innan dokumentet sparas

Exempel

// 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 även

SetPDFUAMode, SetPDFAMode, AddFileAttachment, AddEmbeddedFile, EmbedFile, SetEmbeddedFileStrProperty