SetStructElemAltText

PDF con tag & accessibilità

Descrizione

Imposta la voce /Alt sull'elemento di struttura in fase di creazione nello stack dei tag. Il testo alternativo è la descrizione testuale presentata agli utenti dalle tecnologie assistive, quali lettori di schermo e display braille, quando l'elemento non può essere visualizzato, 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 l'apertura dell'elemento. È utile quando la descrizione viene calcolata o recuperata in modo asincrono dopo che il tipo di elemento è noto

Sintassi

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

Parametri

AltTextDescrizione testuale alternativa da associare all'elemento di struttura corrente. Passare una stringa vuota per cancellare un valore impostato in precedenza.

Valore restituito

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

Note

Chiamare subito dopo BeginTag mentre l'elemento è in cima allo stack, o prima del corrispondente EndTag

AltText e ActualText hanno scopi diversi. AltText è un sostituto testuale completo dell'intero elemento: sostituisce il contenuto visivo per gli utenti che non possono percepire l'output renderizzato. ActualText (ISO 32000-1 §14.9.4) fornisce l'esatta sequenza di caratteri Unicode per i glifi inline il cui testo estratto sarebbe altrimenti errato, ad esempio le legature, e non sostituisce il rendering. Gli screen reader in genere pronunciano AltText per gli elementi Figure e Formula e usano 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 della struttura Figure e Formula. GetPDFUADiagnostics segnala il codice problema FIGURE-NO-ALT:N quando tali elementi sono privi di testo Alt

Esempio

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

Vedere anche

BeginTag, BeginTagEx, SetStructElemActualText, SetStructElemLang, GetPDFUADiagnostics