BeginTagEx2

PDF con tag & accessibilità

Descrizione

Apre un nuovo elemento di struttura, lo inserisce nello stack dei tag e imposta tutte le proprietà principali dell'elemento in un'unica chiamata. BeginTagEx2 è un wrapper pratico per BeginTagEx seguito da SetStructElemTitle, SetStructElemID e SetStructElemExpansion. Il passaggio di una stringa vuota per Title, ElemID o Expansion omette il setter corrispondente; gli altri parametri si comportano esattamente come in BeginTagEx

Usare BeginTagEx2 quando tutte le proprietà sono note all'apertura, evitando più setter. Se una proprietà arriva dopo, usare BeginTag o BeginTagEx e i setter individuali

Sintassi

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

Parametri

TagType	Nome del tipo di elemento struttura, ad esempio `Figure`, `Table`, `Span`, `P`. Gli stessi tipi di BeginTag.
AltText	Testo alternativo scritto nella voce /Alt (ISO 32000-1 §14.9.3). Passare stringa vuota per ometterlo
ActualText	Testo effettivo scritto nella voce /ActualText (ISO 32000-1 §14.9.4). Passare stringa vuota per ometterlo
Lang	Tag BCP 47 scritto in /Lang (ISO 32000-1 §14.9.2), ad esempio `en-US`, `fr`, `zh-Hant-TW`. Stringa vuota eredita la lingua del documento
Title	Etichetta leggibile scritta nella voce /T (ISO 32000-1 §14.7.2). Mostrata nel pannello di navigazione Tags. Passare una stringa vuota per ometterla.
ElemID	Identificatore univoco dell'elemento scritto nella voce /ID (ISO 32000-1 §14.7.4). Se impostato deve essere univoco nel documento. Passare una stringa vuota per ometterlo.
Expansion	Espansione di abbreviazione nella voce /E (ISO 32000-1 §14.9.5). Stringa vuota per omettere

Valore restituito

Restituisce 1 in caso di esito positivo, 0 se nessun documento è selezionato

Note

Chiamare EndTag una volta per ogni chiamata BeginTagEx2 riuscita, per estrarre l'elemento dallo stack dei tag. Gli elementi della 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 singoli setter restano disponibili per le proprietà determinate dopo l'apertura dell'elemento oppure non gestite da BeginTagEx2, come AddTagAttribute per gli attributi delle celle di tabella

Esempio

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

Vedere anche

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion