SetStructElemAltText

Tagged PDF & Accessibility

Beschrijving

Zet de /Alt-entry op het structuurelement dat momenteel op de tagstack wordt opgebouwd. Alternatieve tekst is de tekstbeschrijving die hulptechnologie (screenreaders, brailleleesregels) aan gebruikers presenteert wanneer het element niet visueel kan worden gerenderd — bijvoorbeeld een afbeelding, figuur of wiskundige formule

Deze functie is gelijk aan het doorgeven van een niet-lege AltText-argument aan BeginTag of BeginTagEx, maar laat de alternatieve tekst na het openen van het element worden gezet of bijgewerkt. Dat is handig wanneer de beschrijving pas na het bekend zijn van het elementtype asynchroon wordt berekend of opgehaald

Syntaxis

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

Parameters

Retourwaarde

Returns 1 on success, 0 if no structure element is currently open or no document is selected.

Remarks

Roep deze functie direct na BeginTag aan, terwijl het doelelement bovenaan de tagstack staat, of op elk moment vóór de bijbehorende EndTag-aanroep

AltText en ActualText dienen verschillende doelen. AltText is een volledige tekstuele vervanger van het hele element — hij vervangt de visuele inhoud voor gebruikers die de gerenderde uitvoer niet kunnen waarnemen. ActualText (ISO 32000-1 §14.9.4) levert de exacte Unicode-tekenreeks voor inline glyphs waarvan de geëxtraheerde tekst anders fout zou zijn (zoals ligaturen) en vervangt het renderen niet. Screenreaders spreken doorgaans AltText uit bij Figure- en Formula-elementen en gebruiken ActualText voor correcties op tekenniveau

ISO 32000-1 §14.9.3 definieert de /Alt-entry. PDF/UA-1 (ISO 14289-1 §7.5) vereist alternatieve beschrijvingen bij Figure- en Formula-structuurelementen. GetPDFUADiagnostics meldt de bevindingscode FIGURE-NO-ALT:N wanneer bij Figure- of Formula-elementen alt-tekst ontbreekt

Voorbeeld

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

Zie ook

BeginTag, BeginTagEx, SetStructElemActualText, SetStructElemLang, GetPDFUADiagnostics