SetStructElemAltTextA

Tagged PDF & Accessibility

Beskrivelse

Den avsluttende A angir ANSI-inngangspunktet (char) i DLL-en; ActiveX/COM-flaten eksponerer kun Unicode-formen. Oppførselen er identisk med SetStructElemAltText og strengargumenter tolkes ut fra gjeldende kodetabell i SetAnsiMode

Setter /Alt-oppføringen på strukturelementet som for øyeblikket bygges på tagg-stakken. Alternativ tekst er tekstbeskrivelsen assistiv teknologi (skjermlesere, punktskriftskjermer) presenterer for brukere når elementet ikke kan vises visuelt — for eksempel et bilde, en figur eller en matematisk formel

Denne funksjonen tilsvarer å sende et ikke-tomt AltText-argument til BeginTag eller BeginTagEx, men lar alternativteksten settes eller oppdateres etter at elementet er åpnet. Dette er nyttig når beskrivelsen beregnes eller hentes asynkront etter at elementtypen er kjent

Syntaks

Delphi

Function DLSetStructElemAltTextA(InstanceID: Integer; AltText: PAnsiChar): Integer;

DLL

int DLSetStructElemAltTextA(int InstanceID, const char * AltText);

Parametere

Returverdi

Returnerer 1 ved suksess, 0 hvis ingen strukturelement står åpent eller ingen dokument er valgt

Merknader

Kall denne funksjonen umiddelbart etter BeginTag mens målelementet står øverst på tag-stakken, eller når som helst før det tilsvarende EndTag-kallet

AltText og ActualText tjener ulike formål. AltText er en komplett tekstlig erstatning for hele elementet — den erstatter det visuelle innholdet for brukere som ikke kan oppfatte det renderede resultatet. ActualText (ISO 32000-1 §14.9.4) gir den nøyaktige Unicode-tegnsekvensen for inline-glyfer hvis uttrukne tekst ellers ville blitt feil (slik som ligaturer), og erstatter ikke rendering. Skjermlesere leser typisk opp AltText for Figure- og Formula-elementer og bruker ActualText for tegnnivåkorrigeringer

ISO 32000-1 §14.9.3 definerer /Alt-oppføringen. PDF/UA-1 (ISO 14289-1 §7.5) krever alternative beskrivelser på Figure- og Formula-strukturelementer. GetPDFUADiagnostics rapporterer funnkoden FIGURE-NO-ALT:N når Figure- eller Formula-elementer mangler Alt-tekst

Eksempel

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

Se også

BeginTag, BeginTagEx, SetStructElemActualText, SetStructElemLang, GetPDFUADiagnostics