SetStructElemAltText

Tagged PDF & Accessibility

Description

Imposta la voce /Alt sull'elemento di struttura attualmente in fase di compilazione sullo stack dei tag; il testo alternativo è la descrizione testuale che la tecnologia assistiva (screen reader, display braille) presenta agli utenti quando l'elemento non può essere visualizzato visivamente — ad esempio, un'immagine, una figura o una formula matematica

Questa funzione equivale a passare un argomento AltText non vuoto a BeginTag o BeginTagEx, ma consente di impostare o aggiornare il testo alternativo dopo che l'elemento è stato aperto; è utile quando la descrizione viene calcolata o recuperata in modo asincrono dopo che il tipo di elemento è noto

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	La descrizione testuale alternativa da associare all'elemento di struttura corrente; passare una stringa vuota per cancellare un valore impostato in precedenza

Return value

Restituisce 1 in caso di successo, 0 se nessun elemento di struttura è attualmente aperto o se non è selezionato alcun documento

Remarks

Chiamare questa funzione immediatamente dopo BeginTag mentre l'elemento di destinazione si trova in cima allo stack dei tag, o in qualsiasi momento prima della chiamata EndTag corrispondente

AltText e ActualText servono a scopi diversi; AltText è un sostituto testuale completo per l'intero elemento, ovvero sostituisce il contenuto visivo per gli utenti che non possono percepire l'output reso; ActualText (ISO 32000-1 §14.9.4) fornisce l'esatta sequenza di caratteri Unicode per i glifi incorporati il cui testo estratto risulterebbe altrimenti errato (come le legature) e non sostituisce il rendering; i lettori di schermo in genere pronunciano l'AltText per gli elementi Figure e Formula e utilizzano ActualText per le correzioni a livello di carattere

ISO 32000-1 §14.9.3 definisce la voce /Alt; PDF/UA-1 (ISO 14289-1 §7.5) richiede descrizioni alternative sugli elementi strutturali Figure e Formula; GetPDFUADiagnostics segnala il codice del problema FIGURE-NO-ALT:N quando gli elementi Figure o Formula mancano del testo Alt

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;