BeginTagEx2

PDF marcado & Acessibilidade

Descrição

Abre um novo elemento de estrutura e o coloca no topo da pilha de tags, definindo todas as propriedades principais do elemento em uma única chamada. BeginTagEx2 é um wrapper de conveniência para BeginTagEx seguido de SetStructElemTitle, SetStructElemID e SetStructElemExpansion. Passar uma string vazia em qualquer um dos argumentos Title, ElemID ou Expansion pula o setter correspondente; os demais parâmetros se comportam de forma idêntica aos de BeginTagEx.

Use BeginTagEx2 quando você já conhece todas as propriedades descritivas de um elemento no momento de abri-lo, para evitar várias chamadas de setter consecutivas. Se alguma propriedade só ficar definida depois (por exemplo, o AltText chegar de forma assíncrona), use BeginTag ou BeginTagEx e chame os setters individuais em seguida.

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, ex.: `Figure`, `Table`, `Span`, `P`. Os mesmos tipos aceitos por BeginTag.
AltText	Texto alternativo gravado na entrada /Alt (ISO 32000-1 §14.9.3). Passe uma string vazia para omitir.
ActualText	Texto real gravado na entrada /ActualText (ISO 32000-1 §14.9.4). Passe uma string vazia para omitir.
Lang	Tag de idioma BCP 47 gravada na entrada /Lang (ISO 32000-1 §14.9.2), por exemplo `en-US`, `fr`, `zh-Hant-TW`. Passe uma string vazia para herdar o idioma do documento.
Title	Rótulo legível por humanos gravado na entrada /T (ISO 32000-1 §14.7.2). Aparece no painel de navegação de tags. Passe uma string vazia para omitir.
ElemID	Identificador único do elemento gravado na entrada /ID (ISO 32000-1 §14.7.4). Deve ser único no documento, se definido. Passe uma string vazia para omitir.
Expansion	Expansão de uma abreviatura ou sigla gravada na entrada /E (ISO 32000-1 §14.9.5). Passe uma string vazia para omitir.

Valor de retorno

Retorna 1 em caso de sucesso, 0 se nenhum documento estiver selecionado

Observações

Chame EndTag uma vez para cada chamada bem-sucedida de BeginTagEx2 para retirar o elemento da pilha de tags. Elementos de estrutura podem ser aninhados: chamar BeginTagEx2 com outro elemento aberto cria um elemento filho.

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 setters individuais continuam disponíveis para propriedades determinadas depois que o elemento é aberto, ou para propriedades não cobertas 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;

Veja também

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion