SetStructElemAltText

PDF balisé & accessibilité

Description

Définit l’entrée /Alt de l’élément de structure en cours sur la pile de balises. Le texte alternatif est la description présentée par les technologies d’assistance (lecteurs d’écran, afficheurs braille) lorsque l’élément ne peut pas être rendu visuellement, par exemple une image, une figure ou une formule mathématique

Équivaut à transmettre un argument AltText non vide à BeginTag ou BeginTagEx, mais permet de définir ou actualiser le texte alternatif après l’ouverture de l’élément. Utile lorsque la description est calculée ou récupérée de manière asynchrone après connaissance du type

Syntaxe

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

Paramètres

Valeur de retour

Renvoie 1 en cas de réussite, 0 si aucun élément de structure n'est actuellement ouvert ou si aucun document n'est sélectionné

Remarques

Appelez cette fonction immédiatement après BeginTag, pendant que l’élément cible se trouve au sommet de la pile de balises, ou à tout moment avant l’appel EndTag correspondant

AltText et ActualText remplissent des rôles différents. AltText remplace textuellement l’élément entier — il se substitue au contenu visuel pour les utilisateurs qui ne peuvent percevoir le rendu. ActualText (ISO 32000-1 §14.9.4) fournit la séquence Unicode exacte pour les glyphes en ligne dont le texte extrait serait sinon incorrect, notamment les ligatures, sans remplacer le rendu. Les lecteurs d’écran prononcent généralement AltText pour les éléments Figure et Formula, et emploient ActualText pour les corrections au niveau des caractères

ISO 32000-1 §14.9.3 définit l’entrée /Alt. PDF/UA-1 (ISO 14289-1 §7.5) exige des descriptions alternatives pour les éléments Figure et Formula. GetPDFUADiagnostics signale le code FIGURE-NO-ALT:N lorsque de tels éléments n’ont pas de texte Alt

Exemple

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

Voir aussi

BeginTag, BeginTagEx, SetStructElemActualText, SetStructElemLang, GetPDFUADiagnostics