SetStructElemAltTextA

Маркиран PDF & достъпност

Описание

Завършващата A обозначава точката на вход на DLL от тип ANSI (char); интерфейсът ActiveX/COM предоставя само формата Unicode. Поведението е идентично с SetStructElemAltText, а низовите аргументи се интерпретират с използване на текущата кодова страница на SetAnsiMode

Задава записа /Alt върху структурния елемент, който в момента се изгражда в стека на таговете. Алтернативният текст е текстовото описание, което помощните технологии (екранни четци, брайлови дисплеи) представят на потребителите, когато елементът не може да бъде визуално изобразен — например изображение, фигура или математическа формула

Тази функция е еквивалентна на подаване на ненулев аргумент AltText към BeginTag или BeginTagEx, но позволява алтернативният текст да бъде зададен или обновен след отваряне на елемента. Полезна е, когато описанието се изчислява или извлича асинхронно след като типът на елемента вече е известен

Синтаксис

Delphi

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

DLL

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

Параметри

Върната стойност

Връща 1 при успех, 0 ако няма отворен структурен елемент или не е избран документ

Забележки

Извикайте тази функция непосредствено след BeginTag, докато целевият елемент е най-горе в стека на таговете, или по всяко време преди съответния EndTag

AltText и ActualText служат за различни цели. AltText е пълна текстова заместителна версия на целия елемент — тя заменя визуалното съдържание за потребители, които не могат да възприемат изобразения резултат. ActualText (ISO 32000-1 §14.9.4) предоставя точната последователност от Unicode знаци за вградени глифове, чийто извлечен текст иначе би бил неправилен (като лигатури), и не заменя визуализацията. Екранните четци обикновено произнасят AltText за елементи Figure и Formula, а използват ActualText за корекции на ниво знак

ISO 32000-1 §14.9.3 определя записа /Alt. PDF/UA-1 (ISO 14289-1 §7.5) изисква алтернативни описания за структурните елементи Figure и Formula. GetPDFUADiagnostics отчита кода на проблема FIGURE-NO-ALT:N, когато елементите Figure или Formula нямат Alt текст

Пример

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

Вижте също

BeginTag, BeginTagEx, SetStructElemActualText, SetStructElemLang, GetPDFUADiagnostics