BeginTagEx2

Tagged PDF & Accessibility

Description

Opens a new structure element and pushes it onto the tag stack, setting all main element properties in a single call. BeginTagEx2 is a convenience wrapper for BeginTagEx followed by SetStructElemTitle, SetStructElemID, and SetStructElemExpansion. Passing an empty string for any of Title, ElemID, or Expansion skips the corresponding setter; the other parameters behave identically to BeginTagEx

Gebruik BeginTagEx2 wanneer u al alle beschrijvende eigenschappen van een element kent op het moment dat u het opent, om verschillende opeenvolgende setter-aanroepen te vermijden; Als een eigenschap later wordt bepaald (bijvoorbeeld als de AltText asynchroon binnenkomt), gebruik dan BeginTag of BeginTagEx en roep daarna de afzonderlijke setters aan

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	De naam van het structuurelementtype, bijv. `Figure`, `Table`, `Span`, `P`; dezelfde typen die worden geaccepteerd door BeginTag
AltText	Alternatieve tekst geschreven naar de /Alt vermelding (ISO 32000-1 §14.9.3); geef een lege tekenreeks op om weg te laten
ActualText	Werkelijke tekst geschreven naar de /ActualText vermelding (ISO 32000-1 §14.9.4); geef een lege tekenreeks op om weg te laten
Lang	BCP 47 taalcode geschreven naar de /Lang vermelding (ISO 32000-1 §14.9.2), bijv. `en-US`, `fr`, `zh-Hant-TW`; geef een lege tekenreeks op om de documenttaal te erven
Title	Human-readable label written to the /T entry (ISO 32000-1 §14.7.2). Shown in the Tags navigation panel. Pass an empty string to omit.
ElemID	Unieke elementidentificatie geschreven naar de /ID-vermelding (ISO 32000-1 §14.7.4); Moet uniek zijn binnen het document indien ingesteld; Geef een lege tekenreeks door om weg la laten
Expansion	Expansion of an abbreviation or acronym written to the /E entry (ISO 32000-1 §14.9.5). Pass an empty string to omit.

Return value

Retourneert 1 bij succes, 0 als er geen document is geselecteerd

Remarks

Roep EndTag eenmaal aan voor elke succesvolle BeginTagEx2-aanroep om het element van de tagstapel te halen; structuurelementen kunnen genest zijn: het aanroepen van BeginTagEx2 terwijl een ander element open is, creëert een kindelement

De interne implementatie is exact gelijk aan:

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

Individuele setters blijven beschikbaar voor eigenschappen die worden bepaald nadat het element is geopend, of voor eigenschappen die niet worden gedekt door BeginTagEx2 (zoals AddTagAttribute voor tabelcelkenmerken)

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;