SetEmbeddedFileAFRelationship

PDF/UA i dostępność

Opis

Ustawia klucz AFRelationship w słowniku specyfikacji osadzonego pliku. Jest to wymagane przez ISO 14289-1 (PDF/UA-1) §7.11, gdy osadzone pliki są dołączone do dostępnego dokumentu PDF

Składnia

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

Parametry

Index	Liczony od 1 indeks osadzonego pliku. Prawidłowy zakres: od 1 do EmbeddedFileCount
AFRelationship	Relacja osadzonego pliku z dokumentem. Musi być jedną z następujących wartości z uwzględnieniem wielkości liter: Source — osadzony plik jest plikiem źródłowym użytym do utworzenia dokumentu Data — osadzony plik zawiera dane używane przez dokument Alternative — osadzony plik stanowi alternatywną reprezentację zawartości dokumentu Supplement — osadzony plik jest uzupełnieniem dokumentu Unspecified — relacja nie została określona (wartość domyślna, gdy SetPDFUAMode jest aktywne)

Index

Liczony od 1 indeks osadzonego pliku. Prawidłowy zakres: od 1 do EmbeddedFileCount

AFRelationship

Relacja osadzonego pliku z dokumentem. Musi być jedną z następujących wartości z uwzględnieniem wielkości liter:

Source — osadzony plik jest plikiem źródłowym użytym do utworzenia dokumentu
Data — osadzony plik zawiera dane używane przez dokument
Alternative — osadzony plik stanowi alternatywną reprezentację zawartości dokumentu
Supplement — osadzony plik jest uzupełnieniem dokumentu
Unspecified — relacja nie została określona (wartość domyślna, gdy SetPDFUAMode jest aktywne)

Wartość zwracana

Zwraca 1 w przypadku powodzenia. Zwraca 0, jeśli indeks jest poza zakresem, wartość AFRelationship nie należy do pięciu prawidłowych wartości albo nie otwarto dokumentu

Uwagi

Gdy aktywna jest metoda SetPDFUAMode, PDF Library for Delphi automatycznie ustawia AFRelationship na Unspecified dla każdego osadzonego pliku, który nie ma jeszcze tego klucza. Przed zapisaniem użyj SetEmbeddedFileAFRelationship, aby zastąpić wartość domyślną bardziej szczegółowym typem relacji

Wywołaj tę funkcję po dodaniu osadzonego pliku, a przed zapisaniem dokumentu

Przykład

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

Zobacz również

SetPDFUAMode, SetPDFAMode, AddFileAttachment, AddEmbeddedFile, EmbedFile, SetEmbeddedFileStrProperty