SetStructElemAltText

Tagged PDF & Accessibility

Description

Устанавливает запись /Alt для структурного элемента, создаваемого в данный момент в стеке тегов; альтернативный текст — это текстовое описание, которое вспомогательные технологии (программы чтения с экрана, дисплеи Брайля) представляют пользователям, когда элемент не может быть отображен визуально — например, изображение, рисунок или математическая формула

Эта функция эквивалентна передаче непустого аргумента AltText в BeginTag или BeginTagEx, но позволяет устанавливать или обновлять альтернативный текст после того, как элемент был открыт; это полезно, когда описание вычисляется или извлекается асинхронно после того, как тип элемента уже известен

Syntax

Delphi

Function TPDFlib.SetStructElemAltText(Const AltText: WideString): Integer;

ActiveX

Function PDFlib::SetStructElemAltText(AltText As String) As Long

DLL

int DLSetStructElemAltText(int InstanceID, const wchar_t * AltText);

Parameters

AltText	Описание альтернативного текста для связи с текущим структурным элементом; передайте пустую строку, чтобы очистить ранее установленное значение

Return value

Returns 1 on success, 0 if no structure element is currently open or no document is selected.

Remarks

Вызывайте эту функцию сразу после 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

Example

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