BeginTagEx2

PDF etiquetado & accesibilidad

Descripción

Abre un nuevo elemento de estructura, lo apila en la pila de etiquetas y establece todas las propiedades principales del elemento en una sola llamada. BeginTagEx2 es un contenedor práctico de BeginTagEx seguido de SetStructElemTitle, SetStructElemID y SetStructElemExpansion. Pasar una cadena vacía para Title, ElemID o Expansion omite el método de establecimiento correspondiente; los demás parámetros se comportan igual que en BeginTagEx

Utilice BeginTagEx2 cuando ya conozca todas las propiedades descriptivas de un elemento al abrirlo, para evitar varias llamadas consecutivas a métodos de establecimiento. Si alguna propiedad se determina más tarde (por ejemplo, AltText llega de forma asíncrona), utilice BeginTag o BeginTagEx y llame después a los métodos de establecimiento individuales

Sintaxis

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	Nombre del tipo de elemento, p. ej., `Figure`, `Table`, `Span`, `P`. Los mismos tipos aceptados por BeginTag
AltText	Texto alternativo escrito en la entrada /Alt (ISO 32000-1 §14.9.3). Pase una cadena vacía para omitirlo
ActualText	Texto real escrito en la entrada /ActualText (ISO 32000-1 §14.9.4). Pase una cadena vacía para omitirlo
Lang	Etiqueta de idioma BCP 47 escrita en la entrada /Lang (ISO 32000-1 §14.9.2), por ejemplo, `en-US`, `fr`, `zh-Hant-TW`. Pase una cadena vacía para heredar el idioma del documento
Title	Etiqueta legible escrita en la entrada /T (ISO 32000-1 §14.7.2). Se muestra en el panel de navegación Etiquetas. Pase una cadena vacía para omitirla
ElemID	Identificador único de elemento escrito en /ID (ISO 32000-1 §14.7.4). Debe ser único en el documento si se establece. Pase una cadena vacía para omitirlo
Expansion	Expansión de una abreviatura o sigla escrita en la entrada /E (ISO 32000-1 §14.9.5). Pase una cadena vacía para omitirla

Valor devuelto

Devuelve 1 si se completa correctamente, o 0 si no hay ningún documento seleccionado

Observaciones

Llame a EndTag por cada BeginTagEx2 correcto. Los elementos pueden anidarse y otro BeginTagEx2 crea un hijo

La implementación interna equivale exactamente a:

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

Los establecedores individuales siguen disponibles para las propiedades determinadas después de abrir el elemento o para las propiedades que no abarca BeginTagEx2 (como AddTagAttribute para los atributos de celdas de tabla)

Ejemplo

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

Véase también

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion