SetStructElemActualText

Tagged PDF & Accessibility

Описание

Записывает /ActualText в элемент структуры, который сейчас строится на стеке тегов. ActualText задаёт точный Unicode-текст элемента, перекрывая любой текст, извлечённый из потока содержимого PDF программой чтения

Use this function when the glyphs rendered in the content stream do not directly map to their intended reading-order characters — for example, a ligature glyph (ff, fi, fl) that should read as the two-character sequence ff, fi, or fl. Without ActualText, text-extraction tools and screen readers may produce incorrect output for such glyphs.

Синтаксис

Delphi

Function TPDFlib.SetStructElemActualText(Const ActualText: WideString): Integer;

ActiveX

Function PDFlib::SetStructElemActualText(ActualText As String) As Long

DLL

int DLSetStructElemActualText(int InstanceID, const wchar_t * ActualText);

Параметры

ActualTextUnicode-строка, связываемая с текущим элементом структуры; пустая строка сбрасывает ранее заданное значение

Возвращаемое значение

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

Примечания

Вызывайте сразу после BeginTag или BeginTagEx, пока целевой элемент на вершине стека тегов

ActualText и AltText решают разные задачи. AltText (параметр AltText функции BeginTag) — альтернативное представление всего элемента для ассистивных технологий, когда визуальное содержимое не может быть отрисовано. ActualText дополняет извлечение текста из потока содержимого: он заменяет извлечённую последовательность символов элемента, но не запрещает отрисовку. Экранные дикторы, поддерживающие оба механизма, при наличии ActualText обычно читают вслух именно его

ISO 32000-1 §14.9.4 defines ActualText as a PDF text string entry on the structure element dictionary. PDF/UA-1 (ISO 14289-1 §7.1) requires that text content be extractable and correct; ActualText is the standard mechanism to satisfy this requirement for glyph sequences whose direct extraction would be ambiguous or incorrect.

Пример

// Tag a ligature glyph so that text extraction yields "fi"
PDFlib.BeginTag('Span', '', '');
PDFlib.SetStructElemActualText('fi');
PDFlib.TextOut(x, y, #$FB01);   // U+FB01 LATIN SMALL LIGATURE FI
PDFlib.EndTag;

См. также

BeginTag, BeginTagEx, SetStructElemID, AddTagAttribute, GetPDFUADiagnostics