BeginTagEx2

Tagged PDF & acessibilidade

Descrição

Abre um novo elemento de estrutura e coloca-o na pilha de etiquetas, definindo todas as propriedades principais do elemento numa única chamada. BeginTagEx2 é um invólucro de conveniência de BeginTagEx seguido por SetStructElemTitle, SetStructElemID e SetStructElemExpansion. Passar uma cadeia vazia para Title, ElemID ou Expansion ignora o respetivo método de definição; os outros parâmetros comportam-se de forma idêntica a BeginTagEx

Utilize BeginTagEx2 quando já conhecer todas as propriedades descritivas dum elemento no momento em que o abre, para evitar várias chamadas consecutivas a definidores. Se alguma propriedade for determinada mais tarde (por exemplo, AltText chegar de forma assíncrona), utilize BeginTag ou BeginTagEx e invoque depois os definidores individuais

Sintaxe

Delphi

Function TPDFlib.BeginTagEx2(Const TagType, AltText, ActualText, Lang, Title, ElemID, Expansion: WideString): Integer;

ActiveX

Function PDFlib::BeginTagEx2(TagType As String, AltText As String, ActualText As String, Lang As String, Title As String, ElemID As String, Expansion As String) As Long

DLL

int DLBeginTagEx2(int InstanceID, const wchar_t * TagType, const wchar_t * AltText, const wchar_t * ActualText, const wchar_t * Lang, const wchar_t * Title, const wchar_t * ElemID, const wchar_t * Expansion);

Parâmetros

TagType	O nome do tipo de elemento de estrutura, por exemplo, `Figure`, `Table`, `Span`, `P`. Os mesmos tipos aceites por BeginTag
AltText	Texto alternativo escrito na entrada /Alt (ISO 32000-1 §14.9.3). Passe uma cadeia vazia para o omitir
ActualText	Texto efetivo escrito na entrada /ActualText (ISO 32000-1 §14.9.4). Passe uma cadeia vazia para o omitir
Lang	Etiqueta de idioma BCP 47 escrita na entrada /Lang (ISO 32000-1 §14.9.2), por exemplo, `en-US`, `fr`, `zh-Hant-TW`. Passe uma cadeia vazia para herdar o idioma do documento
Title	Rótulo legível por pessoas escrito na entrada /T (ISO 32000-1 §14.7.2). Apresentado no painel de navegação Tags. Passe uma cadeia vazia para o omitir
ElemID	Identificador de elemento exclusivo escrito na entrada /ID (ISO 32000-1 §14.7.4). Deve ser exclusivo no documento, se for definido. Passe uma cadeia vazia para o omitir
Expansion	Expansão de uma abreviatura ou acrónimo escrita na entrada /E (ISO 32000-1 §14.9.5). Passe uma cadeia vazia para omitir

Valor devolvido

Devolve 1 em caso de êxito, ou 0 se nenhum documento estiver selecionado

Observações

Chame EndTag uma vez por cada chamada bem-sucedida a BeginTagEx2 para retirar o elemento da pilha de etiquetas. Os elementos de estrutura podem ser aninhados: chamar BeginTagEx2 enquanto outro elemento está aberto cria um elemento subordinado

A implementação interna é exatamente equivalente a:

BeginTagEx(TagType, AltText, ActualText, Lang);
if Title <> '' then SetStructElemTitle(Title);
if ElemID <> '' then SetStructElemID(ElemID);
if Expansion <> '' then SetStructElemExpansion(Expansion);

Os definidores individuais continuam disponíveis para propriedades determinadas após a abertura do elemento ou para propriedades não abrangidas por BeginTagEx2 (como AddTagAttribute para atributos de células de tabela)

Exemplo

// Tag a figure with all descriptive properties in one call
PDFlib.BeginTagEx2(
  'Figure',                              // TagType
  'Bar chart: Q1 120, Q2 145, Q3 98',   // AltText
  '',                                    // ActualText (not needed for images)
  '',                                    // Lang (inherit document language)
  'Figure 3: Quarterly Sales',           // Title
  'fig-quarterly-sales',                 // ElemID
  ''                                     // Expansion (not an abbreviation)
);
PDFlib.SetStructElemBBox(x, y, x + w, y + h);
PDFlib.DrawImage(imgHandle, x, y, w, h);
PDFlib.EndTag;

// Tag an acronym span with its expansion
PDFlib.BeginTagEx2(
  'Span',
  '',                                          // AltText
  '',                                          // ActualText
  '',                                          // Lang
  '',                                          // Title
  '',                                          // ElemID
  'World Wide Web Consortium'                  // Expansion
);
PDFlib.WriteText('W3C');
PDFlib.EndTag;

Consulte também

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion