SetStructElemAltTextA

Tagged PDF & Accessibility

Опис

Завершальна 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);

Параметри

Return value

Повертає 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