SetStructElemTitleA

PDF marcado & Acessibilidade

Descrição

O sufixo A indica o ponto de entrada ANSI (char) da DLL; a superfície ActiveX/COM expõe apenas a forma Unicode. O comportamento é idêntico ao de SetStructElemTitle e os argumentos de string são interpretados usando a página de código atual definida por SetAnsiMode

Define a entrada /T (título) no elemento de estrutura sendo construído no topo da pilha de tags. O título é um rótulo legível por humanos que caracteriza o elemento específico — por exemplo Capítulo 1, Tabela Resumo ou Figura 3: Vendas Trimestrais — em vez de meramente repetir o tipo do elemento.

Sintaxe

Delphi

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

DLL

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

Parâmetros

Title	Uma string de texto legível que identifica esta instância específica do elemento. Passe uma string vazia para limpar um valor definido anteriormente.

Valor de retorno

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

Observações

A entrada /T é definida na ISO 32000-1 §14.7.2 Tabela 324. É gravada como uma text string do PDF no dicionário do elemento de estrutura.

Title serve a um propósito distinto das outras propriedades de texto de um elemento de estrutura:

/T (Title) — Um rótulo descritivo do elemento, usado em painéis de navegação e de marcação. Adequado para títulos de seção, legendas de tabela e legendas de figura.
/Alt (ver SetStructElemAltText) — Um substituto textual completo do elemento para tecnologia assistiva quando o elemento não pode ser renderizado.
/ActualText (see SetStructElemActualText) — An exact Unicode replacement for glyph sequences whose extracted text would be incorrect.

Visualizadores de PDF usam /T para rotular elementos no painel de navegação de tags. Ferramentas de acessibilidade e de remediação o usam como título de referência para navegar no documento. Para elementos de heading (H1–H6), o próprio conteúdo do elemento serve como texto do heading; /T é mais útil para elementos não textuais (Table, Figure, Form) ou contêineres (Sect, Div) que precisem de um rótulo descritivo.

Exemplo

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

Veja também

BeginTag, SetStructElemAltText, SetStructElemActualText, SetStructElemID, GetPDFUADiagnostics