SetStructElemAltText

Tagged PDF ja saavutettavuus

Kuvaus

Asettaa /Alt-tietueen tagipinossa parhaillaan rakennettavalle rakennetyylielementille. Vaihtoehtoteksti on tekstikuvaus, jonka avustava teknologia (ruudunlukijat, pistenäytöt) esittää käyttäjille, kun elementtiä ei voi renderöidä visuaalisesti — esimerkiksi kuva, figuuri tai matemaattinen kaava

Tämä funktio vastaa ei-tyhjän AltText-argumentin antamista BeginTagille tai BeginTagExille, mutta sallii vaihtoehtotekstin asettamisen tai päivittämisen sen jälkeen, kun elementti on jo avattu. Tästä on hyötyä, kun kuvaus lasketaan tai haetaan asynkronisesti elementtityypin selvittyä

Syntaksi

Delphi

Function TPDFlib.SetStructElemAltText(Const AltText: WideString): Integer;

ActiveX

Function PDFlib::SetStructElemAltText(AltText As String) As Long

DLL

int DLSetStructElemAltText(int InstanceID, const wchar_t * AltText);

Parametrit

Paluuarvo

Palauttaa arvon 1 onnistuessaan, arvon 0, jos mikään rakennetyylielementti ei ole parhaillaan avoinna tai mikään asiakirja ei ole valittuna

Huomautukset

Kutsu tätä funktiota heti BeginTag-kutsun jälkeen, kun kohdeelementti on tagipinon päällä, tai milloin tahansa ennen vastaavaa EndTag-kutsua

AltText ja ActualText palvelevat eri tarkoituksia. AltText on täydellinen tekstimainen korvike koko elementille — se korvaa visuaalisen sisällön käyttäjille, jotka eivät voi havaita renderöityä tulosta. ActualText (ISO 32000-1 §14.9.4) toimittaa täsmällisen Unicode-merkkisarjan sisäisille glyyfeille, joiden poimittu teksti muuten olisi virheellinen (kuten ligatuurit), eikä se korvaa renderöintiä. Ruudunlukijat puhuvat tyypillisesti AltTextin Figure- ja Formul

ISO 32000-1 §14.9.3 määrittelee /Alt-tietueen. PDF/UA-1 (ISO 14289-1 §7.5) edellyttää vaihtoehdokuvauksia Figure- ja Formula-rakennetyylielementeiltä. GetPDFUADiagnostics raportoi ongelmakoodin FIGURE-NO-ALT:N, kun Figure- tai Formula-elementeiltä puuttuu Alt-teksti

Esimerkki

// Tag an embedded chart image with alternative text
PDFlib.BeginTag('Figure', '', '');
PDFlib.SetStructElemAltText('Bar chart: Q1 sales 120, Q2 sales 145, Q3 sales 98');
PDFlib.SetStructElemBBox(x, y, x + w, y + h);
PDFlib.DrawImage(imgHandle, x, y, w, h);
PDFlib.EndTag;

Katso myös

BeginTag, BeginTagEx, SetStructElemActualText, SetStructElemLang, GetPDFUADiagnostics