SetStructElemAltTextA

Tagged PDF & tilgængelighed

Beskrivelse

Det afsluttende A angiver ANSI-indgangspunktet (char) i DLL'en; ActiveX/COM-overfladen eksponerer kun Unicode-formen. Adfærden er identisk med SetStructElemAltText, og strengargumenter fortolkes ud fra den aktuelle kodetabel i SetAnsiMode

Indstiller /Alt-posten på det strukturelement, der aktuelt opbygges på tagstakken. Alternativ tekst er den tekstbeskrivelse, som kompenserende teknologi (skærmlæsere og brailledisplays) præsenterer for brugere, når elementet ikke kan gengives visuelt — f.eks. et billede, en figur eller en matematisk formel.

Denne funktion svarer til at angive et ikke-tomt AltText-argument til BeginTag eller BeginTagEx, men gør det muligt at indstille eller opdatere den alternative tekst, efter at elementet er åbnet. Den er nyttig, når beskrivelsen beregnes eller hentes asynkront, efter at elementtypen er kendt

Syntaks

Delphi

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

DLL

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

Parametre

Returværdi

Returnerer 1 ved succes, 0 hvis intet strukturelement er åbent, eller intet dokument er valgt

Bemærkninger

Kald denne funktion umiddelbart efter BeginTag, mens målelementet ligger øverst på tagstakken, eller på et hvilket som helst tidspunkt før det tilsvarende kald til EndTag.

AltText og ActualText har forskellige formål. AltText er en fuldstændig tekstlig erstatning for hele elementet — den erstatter det visuelle indhold for brugere, som ikke kan opfatte det gengivne output. ActualText (ISO 32000-1 §14.9.4) angiver den nøjagtige Unicode-tegnsekvens for indlejrede glyffer, hvis udtrukne tekst ellers ville være forkert (f.eks. ligaturer), og erstatter ikke gengivelsen. Skærmlæsere oplæser typisk AltText for Figure- og Formula-elementer og bruger ActualText til rettelser på tegnniveau

ISO 32000-1 §14.9.3 definerer posten /Alt. PDF/UA-1 (ISO 14289-1 §7.5) kræver alternative beskrivelser på Figure- og Formula-strukturelementer. GetPDFUADiagnostics rapporterer problemkoden 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