SetStructElemTitleA

Структурированный PDF и доступность

Описание

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

Задаёт запись /T (заголовок) у структурного элемента, который сейчас строится на стеке тегов. Заголовок — это понятная человеку метка, характеризующая конкретный элемент — например Глава 1, Сводная таблица или Рисунок 3: Квартальные продажи, — а не просто повторение типа элемента.

Синтаксис

Delphi

Function DLSetStructElemTitleA(InstanceID: Integer; Title: PAnsiChar): Integer;

DLL

int DLSetStructElemTitleA(int InstanceID, const char * Title);

Параметры

Title	Текстовая строка для человека, идентифицирующая этот экземпляр элемента. Пустая строка сбрасывает ранее заданное значение

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

Возвращает 1 при успехе, 0 если открытый структурный элемент отсутствует или документ не выбран.

Примечания

Запись /T определена в ISO 32000-1 §14.7.2, таблица 324. Записывается как текстовая строка PDF в словарь структурного элемента.

Title служит иной цели, чем остальные текстовые свойства элемента структуры:

/T (Title) — Описательная метка элемента, применяемая в панелях навигации и тегирования. Подходит для заголовков разделов, названий таблиц и подписей к рисункам.
/Alt (см. SetStructElemAltText) — Полная текстовая замена элемента для ассистивных технологий, когда элемент не может быть отрисован.
/ActualText (see SetStructElemActualText) — An exact Unicode replacement for glyph sequences whose extracted text would be incorrect.

Просмотрщики PDF используют /T для подписи элементов в навигационной панели тегов. Средства доступности и ПО для исправления документов применяют его как ориентирный заголовок при навигации по документу. У элементов заголовков (H1–H6) текстом заголовка служит само содержимое элемента; /T полезнее для нетекстовых элементов (Table, Figure, Form) или контейнеров (Sect, Div), которым нужна описательная метка.

Пример

// Tag a data table with a title for navigation and accessibility tools
PDFlib.BeginTag('Table', '', '');
PDFlib.SetStructElemTitle('Table 2: Annual Revenue by Region');
// ... table rows and cells
PDFlib.EndTag;

// Tag a document section
PDFlib.BeginTag('Sect', '', '');
PDFlib.SetStructElemTitle('Chapter 3: Implementation');
// ... section content
PDFlib.EndTag;

См. также

BeginTag, SetStructElemAltText, SetStructElemActualText, SetStructElemID, GetPDFUADiagnostics