SetEmbeddedFileAFRelationship

PDF/UA ja saavutettavuus

Kuvaus

Asettaa AFRelationship-avaimen upotetun tiedoston tiedostomäärittelysanakirjaan. Vaaditaan standardissa ISO 14289-1 (PDF/UA-1) §7.11, kun esteellinen PDF-asiakirja sisältää upotettuja tiedostoja

Syntaksi

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

Parametrit

Index	Upotetun tiedoston nollapohjainen indeksi. Kelvollinen alue: 0 – EmbeddedFileCount - 1
AFRelationship	Upotetun tiedoston suhde asiakirjaan. Arvon on oltava jokin seuraavista kirjainkokoa erottelevista arvoista: Source — upotettu tiedosto on asiakirjan luomisessa käytetty lähdetiedosto Data — upotettu tiedosto sisältää asiakirjan käyttämää dataa Alternative — upotettu tiedosto on vaihtoehtoinen esitys asiakirjan sisällöstä Supplement — upotettu tiedosto täydentää asiakirjaa Unspecified — suhdetta ei ole määritelty (oletus)

Index

Upotetun tiedoston nollapohjainen indeksi. Kelvollinen alue: 0 – EmbeddedFileCount - 1

AFRelationship

Upotetun tiedoston suhde asiakirjaan. Arvon on oltava jokin seuraavista kirjainkokoa erottelevista arvoista:

Source — upotettu tiedosto on asiakirjan luomisessa käytetty lähdetiedosto
Data — upotettu tiedosto sisältää asiakirjan käyttämää dataa
Alternative — upotettu tiedosto on vaihtoehtoinen esitys asiakirjan sisällöstä
Supplement — upotettu tiedosto täydentää asiakirjaa
Unspecified — suhdetta ei ole määritelty (oletus)

Paluuarvo

Palauttaa arvon 1 onnistuessaan. Palauttaa arvon 0, jos indeksi on alueen ulkopuolella, AFRelationship-arvo ei ole jokin viidestä kelvollisesta arvosta tai mikään asiakirja ei ole avoinna

Huomautukset

Kun SetPDFUAMode on käytössä, PDF Library for Delphi asettaa automaattisesti AFRelationshipin arvoon Unspecified jokaiselle upotetulle tiedostolle, jolla avainta ei vielä ole. Tallennusta edeltävällä SetEmbeddedFileAFRelationship-kutsulla oletuksen voi ohittaa täsmällisemmällä suhdearvolla

Kutsu tätä funktiota upotetun tiedoston lisäämisen jälkeen ja ennen asiakirjan tallennusta

Esimerkki

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

Katso myös

SetPDFUAMode, SetPDFAMode, AddFileAttachment, AddEmbeddedFile, EmbedFile, SetEmbeddedFileStrProperty