SetStructElemAltText

Tagged PDF & Accessibility

Description

Define a entrada /Alt no elemento de estrutura atualmente sendo construído na pilha de tags. O texto alternativo é a descrição de texto que a tecnologia assistiva (leitores de tela, visores braille) apresenta aos usuários quando o elemento não pode ser renderizado visualmente — por exemplo, uma imagem, figura ou fórmula matemática

Esta função é equivalente a passar un argumento AltText não vazio para BeginTag ou BeginTagEx, mas permite que o texto alternativo seja definido ou atualizado após a abertura do elemento; é útil quando a descrição é computada ou recuperada de forma assíncrona após o tipo do elemento ser conhecido

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	A descrição de texto alternativa para associar ao elemento de estrutura atual; passe uma string vazia para limpar um valor definido anteriormente

Return value

Retorna 1 em caso de sucesso, 0 se nenhum elemento de estrutura estiver aberto no momento ou se nenhum documento estiver selecionado

Remarks

Chame esta função imediatamente após BeginTag enquanto o elemento de destino estiver no topo da pilha de tags, ou a qualquer momento antes da chamada correspondente a EndTag

AltText e ActualText servem a propósitos diferentes; AltText é um substituto textual completo para todo o elemento — ele substitui o conteúdo visual para usuários que não podem perceber a saída renderizada; ActualText (ISO 32000-1 §14.9.4) fornece a sequência exata de caracteres Unicode para glifos inline cujo texto extraído de outra forma estaria incorreto (como ligaduras), e não substitui a renderização; leitores de tela normalmente lêem AltText para elementos Figure e Formula, e usam ActualText para correções em nível de caractere

A norma ISO 32000-1 §14.9.3 define a entrada /Alt; a PDF/UA-1 (ISO 14289-1 §7.5) exige descrições alternativas nos elementos de estrutura Figure e Formula; o método GetPDFUADiagnostics relata o código de problema FIGURE-NO-ALT:N quando elementos Figure ou Formula não possuem o texto Alt

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;