SetStructElemAltText

PDF etiquetado & accesibilidad

Descripción

Establece la entrada /Alt en el elemento de estructura que se está creando actualmente en la pila de etiquetas El texto alternativo es la descripción textual que la tecnología de asistencia (lectores de pantalla, pantallas braille) presenta a los usuarios cuando el elemento no se puede representar visualmente — por ejemplo, una imagen, figura o fórmula matemática

Esta función equivale a pasar un argumento AltText no vacío a BeginTag o BeginTagEx, pero permite establecer o actualizar el texto alternativo después de abrir el elemento. Es útil cuando la descripción se calcula o se recupera de forma asíncrona después de conocer el tipo de elemento

Sintaxis

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

Parámetros

AltText	La descripción de texto alternativo que se asociará al elemento de estructura actual. Pase una cadena vacía para borrar un valor establecido anteriormente

Valor devuelto

Devuelve 1 si tiene éxito, 0 si no hay ningún elemento de estructura abierto actualmente o no hay ningún documento seleccionado

Observaciones

Llame a esta función inmediatamente después de BeginTag mientras el elemento de destino está en la parte superior de la pila de etiquetas, o en cualquier momento antes de la llamada EndTag correspondiente

AltText y ActualText tienen finalidades diferentes AltText es un sustituto textual completo para todo el elemento: reemplaza el contenido visual para usuarios que no pueden percibir la salida representada ActualText (ISO 32000-1 §14.9.4) proporciona la secuencia exacta de caracteres Unicode para glifos en línea cuyo texto extraído sería incorrecto de otro modo (como las ligaduras), y no reemplaza la representación Los lectores de pantalla suelen leer AltText en voz alta para los elementos Figure y Formula, y usan ActualText para correcciones a nivel de carácter

ISO 32000-1 §14.9.3 define la entrada /Alt. PDF/UA-1 (ISO 14289-1 §7.5) requiere descripciones alternativas en elementos de estructura Figure y Formula. GetPDFUADiagnostics informa el código de problema FIGURE-NO-ALT:N cuando a los elementos Figure o Formula les falta texto Alt

Ejemplo

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

Véase también

BeginTag, BeginTagEx, SetStructElemActualText, SetStructElemLang, GetPDFUADiagnostics