SetStructElemActualText

Tagged PDF & Accessibility

Description

Imposta la voce /ActualText sull'elemento di struttura attualmente in fase di compilazione sullo stack dei tag; ActualText fornisce il testo Unicode esatto rappresentato dall'elemento, sovrascrivendo qualsiasi testo estratto dal flusso di contenuti PDF dal software di lettura

Usare questa funzione quando i glifi renderizzati nello stream di contenuto non si mappano direttamente sui caratteri desiderati nell'ordine di lettura — ad esempio, un glifo di legatura (ff, fi, fl) che dovrebbe essere letto como la sequenza di due caratteri ff, fi o fl; senza ActualText, gli strumenti di estrazione del testo e gli screen reader potrebbero produrre un output non corretto per tali glifi

Syntax

Delphi

Function TPDFlib.SetStructElemActualText(Const ActualText: WideString): Integer;

ActiveX

Function PDFlib::SetStructElemActualText(ActualText As String) As Long

DLL

int DLSetStructElemActualText(int InstanceID, const wchar_t * ActualText);

Parameters

ActualTextLa stringa di testo Unicode 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 o BeginTagEx mentre l'elemento di destinazione si trova in cima allo stack dei tag

ActualText e AltText servono a scopi diversi; AltText (impostato tramite il parametro AltText di BeginTag) è una rappresentazione alternativa dell'intero elemento destinata alle tecnologie assistive quando il contenuto visivo non può essere reso; ActualText integra l'estrazione del testo dal flusso di contenuti: sostituisce la sequenza di caratteri estratta dell'elemento ma non ne impedisce il rendering; i lettori di schermo che supportano entrambi utilizzeranno in genere ActualText per la lettura ad alta voce quando presente

ISO 32000-1 §14.9.4 definisce ActualText come una voce di stringa di testo PDF nel dizionario degli elementi strutturali; PDF/UA-1 (ISO 14289-1 §7.1) richiede che il contenuto del testo sia estraibile e corretto; ActualText è il meccanismo standard per soddisfare questo requisito per le sequenze di glifi la cui estrazione diretta sarebbe ambigua o errata

Example

// Tag a ligature glyph so that text extraction yields "fi"
PDFlib.BeginTag('Span', '', '');
PDFlib.SetStructElemActualText('fi');
PDFlib.TextOut(x, y, #$FB01);   // U+FB01 LATIN SMALL LIGATURE FI
PDFlib.EndTag;

See also

BeginTag, BeginTagEx, SetStructElemID, AddTagAttribute, GetPDFUADiagnostics