BeginTagEx2

Tagged PDF & Accessibility

Description

Abre um novo elemento de estrutura e o envia para a pilha de tags, definindo todas as propriedades principais do elemento em uma única chamada; BeginTagEx2 é um wrapper de conveniência para BeginTagEx seguido por SetStructElemTitle, SetStructElemID e SetStructElemExpansion; passar uma string vazia para qualquer um de Title, ElemID ou Expansion ignora o definidor correspondente; os outros parâmetros se comportam de forma idêntica a BeginTagEx

Use BeginTagEx2 quando você já conhecer todas as propriedades descritivas de um elemento no momento em que o abrir, para evitar várias chamadas consecutivas de definidores; se alguma propriedade for determinada posteriormente (por exemplo, o AltText chega de forma assíncrona), use BeginTag ou BeginTagEx e chame os definidores individuais posteriormente

Syntax

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

Parameters

TagType	O nome do tipo de elemento de estrutura, por exemplo, `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); exibido no painel de navegação de Tags; passe uma string vazia para omitir
ElemID	Identificador de elemento exclusivo gravado na entrada /ID (ISO 32000-1 §14.7.4); deve ser exclusivo dentro do documento se definido; passe uma string vazia para omitir
Expansion	Expansão de uma abreviação ou acrônimo gravado na entrada /E (ISO 32000-1 §14.9.5); passe uma string vazia para omitir

Return value

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

Remarks

Chame EndTag uma vez para cada chamada bem-sucedida a BeginTagEx2 para remover o elemento da pilha de tags; elementos de estrutura podem ser aninhados: chamar BeginTagEx2 enquanto outro elemento está 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);

Definidores individuais permanecem disponíveis para propriedades determinadas após a abertura do elemento, ou para propriedades não cobertas por BeginTagEx2 (como AddTagAttribute para atributos de célula de tabela)

Example

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