BeginTagEx2

Tagged PDF & Accessibility

Description

Apre un nuovo elemento della struttura e lo inserisce nello stack dei tag, impostando tutte le proprietà principali dell'elemento in una singola chiamata; BeginTagEx2 è un wrapper di comodo per BeginTagEx seguito da SetStructElemTitle, SetStructElemID e SetStructElemExpansion; il passaggio di una stringa vuota per uno qualsiasi tra Title, ElemID o Expansion salta il rispettivo setter; gli altri parametri si comportano in modo identico a BeginTagEx

Usare BeginTagEx2 quando si conoscono già tutte le proprietà descrittive di un elemento nel momento in cui lo si apre, in modo da evitare diverse chiamate consecutive ai setter; se una proprietà viene definita successivamente (ad esempio, AltText arriva in modo asincrono), usare BeginTag o BeginTagEx e chiamare i singoli setter in seguito

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	Il nome del tipo di elemento di struttura, ad es. `Figure`, `Table`, `Span`, `P`; gli stessi tipi accettati da BeginTag
AltText	Testo alternativo scritto nella voce /Alt (ISO 32000-1 §14.9.3); passare una stringa vuota per omettere
ActualText	Testo effettivo scritto nella voce /ActualText (ISO 32000-1 §14.9.4); passare una stringa vuota per omettere
Lang	Tag di lingua BCP 47 scritto nella voce /Lang (ISO 32000-1 §14.9.2), ad esempio `en-US`, `fr`, `zh-Hant-TW`; passare una stringa vuota per ereditare la lingua del documento
Title	Etichetta leggibile dall'uomo scritta nella voce /T (ISO 32000-1 §14.7.2); mostrata nel pannello di navigazione Tag; passare una stringa vuota per omettere
ElemID	Identificatore univoco dell'elemento scritto nella voce /ID (ISO 32000-1 §14.7.4); deve essere univoco all'interno del documento se impostato; passare una stringa vuota per omettere
Expansion	Espansione di un'abbreviazione o acronimo scritta nella voce /E (ISO 32000-1 §14.9.5); passare una stringa vuota per omettere

Return value

Restituisce 1 in caso di successo, 0 se non è selezionato alcun documento

Remarks

Chiamare EndTag una volta per ogni chiamata a BeginTagEx2 andata a buon fine per rimuovere l'elemento dallo stack dei tag; gli elementi di struttura possono essere annidati: chiamare BeginTagEx2 mentre un altro elemento è aperto crea un elemento figlio

L'implementazione interna è esattamente equivalente a:

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

I setter individuali rimangono disponibili per le proprietà determinate dopo l'apertura dell'elemento, o per le proprietà non coperte da BeginTagEx2 (come AddTagAttribute per gli attributi delle celle di tabella)

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;