SetEmbeddedFileAFRelationship

PDF/UA & accessibilité

Description

Définit la clé AFRelationship dans le dictionnaire de spécification de fichier d’un fichier incorporé. Cette clé est exigée par ISO 14289-1 (PDF/UA-1) §7.11 lorsque des fichiers incorporés sont inclus dans un document PDF accessible

Syntaxe

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

Paramètres

Index	Index du fichier incorporé à partir de 1 Plage valide : de 1 à EmbeddedFileCount
AFRelationship	Relation du fichier incorporé avec le document. Elle doit être l’une des valeurs sensibles à la casse suivantes : Source — le fichier incorporé est le fichier source ayant servi à créer le document Data — le fichier incorporé contient des données utilisées par le document Alternative — le fichier incorporé constitue une représentation alternative du contenu du document Supplement — le fichier incorporé complète le document Unspecified — la relation n’est pas indiquée (valeur par défaut lorsque SetPDFUAMode est actif)

Index

Index du fichier incorporé à partir de 1 Plage valide : de 1 à EmbeddedFileCount

AFRelationship

Relation du fichier incorporé avec le document. Elle doit être l’une des valeurs sensibles à la casse suivantes :

Source — le fichier incorporé est le fichier source ayant servi à créer le document
Data — le fichier incorporé contient des données utilisées par le document
Alternative — le fichier incorporé constitue une représentation alternative du contenu du document
Supplement — le fichier incorporé complète le document
Unspecified — la relation n’est pas indiquée (valeur par défaut lorsque SetPDFUAMode est actif)

Valeur de retour

Renvoie 1 en cas de réussite. Renvoie 0 si l'indice est hors plage, si AFRelationship n'est pas l'une des cinq valeurs valides ou si aucun document n'est ouvert

Remarques

Lorsque SetPDFUAMode est actif, PDF Library for Delphi définit automatiquement AFRelationship sur Unspecified pour tout fichier incorporé dépourvu de la clé. Utilisez SetEmbeddedFileAFRelationship avant l’enregistrement pour remplacer cette valeur par une relation plus précise

Appelez cette fonction après avoir ajouté le fichier incorporé et avant d'enregistrer le document

Exemple

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

Voir aussi

SetPDFUAMode, SetPDFAMode, AddFileAttachment, AddEmbeddedFile, EmbedFile, SetEmbeddedFileStrProperty