SetStructElemAltTextA

Tagged PDF & Accessibility

Aprašymas

Galūnė A žymi ANSI (char) DLL įėjimo tašką; ActiveX/COM sąsaja atskleidžia tik Unicode formą. Elgsena tokia pat kaip SetStructElemAltText, o eilučių argumentai aiškinami naudojant dabartinį SetAnsiMode kodų puslapį

Sets the /Alt entry on the structure element currently being built on the tag stack. Alternative text is the text description that assistive technology (screen readers, braille displays) presents to users when the element cannot be rendered visually — for example, an image, figure, or mathematical formula.

Ši funkcija lygi netuščiojo AltText argumento perdavimui BeginTag arba BeginTagEx, bet leidžia alternativųjį tekstą nustatyti arba atnaujinti po to, kai elementas atvertas. Tai naudinga, kai aprašymas apskaičiuojamas arba gaunamas asinchroniškai po to, kai žinomas elemento tipas

Sintaksė

Delphi

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

DLL

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

Parametrai

Grąžinama reikšmė

Grąžina 1 sėkmės atveju, 0, jei šiuo metu neatvertas joks struktūros elementas arba nepasirinktas joks dokumentas

Pastabos

Iškvieskite šią funkciją iškart po BeginTag, kol tikslinasis elementas yra žymų dėkelio viršuje, arba bet kuriuo momentu prieš atitinkamąjį EndTag kvietimą

AltText and ActualText serve different purposes. AltText is a complete textual substitute for the entire element — it replaces the visual content for users who cannot perceive the rendered output. ActualText (ISO 32000-1 §14.9.4) provides the exact Unicode character sequence for inline glyphs whose extracted text would otherwise be incorrect (such as ligatures), and does not replace rendering. Screen readers typically speak AltText for Figure and Formula elements, and use ActualText for character-level corrections.

ISO 32000-1 §14.9.3 defines the /Alt entry. PDF/UA-1 (ISO 14289-1 §7.5) requires alternative descriptions on Figure and Formula structure elements. GetPDFUADiagnostics reports the FIGURE-NO-ALT:N issue code when Figure or Formula elements are missing Alt text.

Pavyzdys

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

Taip pat žiūrėkite

BeginTag, BeginTagEx, SetStructElemActualText, SetStructElemLang, GetPDFUADiagnostics