SetStructElemAltText

Tagged PDF & Accessibility

Description

Sätter posten /Alt på det strukturelement som för tillfället byggs på taggstacken. Alternativ text är den textbeskrivning som hjälpmedelsteknik (skärmläsare, punktskriftsdisplayer) presenterar för användare när elementet inte kan renderas visuellt — till exempel en bild, figur eller matematisk formel

Den här funktionen är ekvivalent med att skicka ett icke-tomt AltText-argument till BeginTag eller BeginTagEx, men låter den alternativa texten sättas eller uppdateras efter att elementet öppnats. Den är användbar när beskrivningen beräknas eller hämtas asynkront efter att elementtypen blivit känd

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	Den alternativa textbeskrivning som ska knytas till det aktuella strukturelementet. Ange en tom sträng för att rensa ett tidigare satt värde

Return value

Returnerar 1 vid lyckat anrop, 0 om inget strukturelement för tillfället är öppet eller inget dokument är valt

Remarks

Anropa den här funktionen omedelbart efter BeginTag medan målelementet ligger överst på taggstacken, eller när som helst före det matchande EndTag-anropet

AltText och ActualText fyller olika syften. AltText är en komplett textersättning för hela elementet — den ersätter det visuella innehållet för användare som inte kan uppfatta det renderade resultatet. ActualText (ISO 32000-1 §14.9.4) tillhandahåller den exakta Unicode-teckensekvensen för inline-glyfer vars extraherade text i annat fall skulle bli fel (som ligaturer) och ersätter inte renderingen. Skärmläsare läser typiskt upp AltText för Figure- och Formula-element och använder ActualText för teckenkorrigeringar

ISO 32000-1 §14.9.3 definierar posten /Alt. PDF/UA-1 (ISO 14289-1 §7.5) kräver alternativa beskrivningar på Figure- och Formula-strukturelement. GetPDFUADiagnostics rapporterar problemkoden FIGURE-NO-ALT:N när Figure- eller Formula-element saknar 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;