SetStructElemAltText

Tagged PDF & Accessibility

Description

Stelt het /Alt-item in op het structuurelement dat momenteel op de tag-stack wordt gebouwd; alternatieve tekst is de tekstbeschrijving die ondersteunende technologie (schermlezers, brailledisplays) aan gebruikers presenteert wanneer het element niet visueel kan worden weergegeven — bijvoorbeeld een afbeelding, figuur of wiskundige formule

Deze functie is equivalent aan het doorgeven van een niet-leeg argument AltText aan BeginTag of BeginTagEx, maar maakt het mogelijk om de alternatieve tekst in te stellen of bij te werken nadat het element is geopend; het is handig wanneer de beschrijving asynchroon wordt berekend of opgehaald nadat het elementtype bekend is

Syntax

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

AltText	De alternatieve tekstbeschrijving die aan het huidige structuurelement moet worden gekoppeld; geef een lege string door om een eerder ingestelde waarde te wissen

Return value

Retourneert 1 bij succes, 0 als er momenteel geen structuurelement geopend is of als er geen document is geselecteerd

Remarks

Roep deze functie onmiddellijk aan na BeginTag terwijl het doelelement zich bovenaan de tagstapel bevindt, of op elk moment vóór de bijbehorende EndTag-aanroep

AltText en ActualText dienen verschillende doeleinden; AltText is een volledige tekstuele vervanging voor het gehele element — het vervangt de visuele inhoud voor gebruikers die de gerenderde uitvoer niet kunnen waarnemen; ActualText (ISO 32000-1 §14.9.4) biedt de exacte Unicode-karakterreeks voor inline-gliefen waarvan de geëxtraheerde tekst anders onjuist zou zijn (zoals ligaturen), en vervangt de weergave niet; schermlezers spreken doorgaans AltText uit voor Figure- en Formula-elementen, en gebruiken ActualText voor correcties op karakterniveau

ISO 32000-1 §14.9.3 defines the /Alt entry. PDF/UA-1 (ISO 14289-1 §7.5) requires alternative descriptions on Figure and Formula structure elements. GetPDFUADiagnostics reports the FIGURE-NO-ALT:N issue code when Figure or Formula elements are missing Alt text.

Example

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