BeginTagEx2

Tagged PDF & Accessibility

Description

Öffnet ein neues Strukturelement, legt es auf den Tag-Stapel und legt alle Hauptelementeigenschaften in einem einzigen Aufruf fest; BeginTagEx2 ist ein praktischer Wrapper für BeginTagEx, gefolgt von SetStructElemTitle, SetStructElemID und SetStructElemExpansion; das Übergeben einer leeren Zeichenkette für Title, ElemID oder Expansion überspringt den entsprechenden Setter; die anderen Parameter verhalten sich identisch zu BeginTagEx

Verwenden Sie BeginTagEx2, wenn Sie bereits alle beschreibenden Eigenschaften eines Elements zum Zeitpunkt des Öffnens kennen, um mehrere aufeinanderfolgende Setter-Aufrufe zu vermeiden. Wenn eine Eigenschaft erst später bestimmt wird (z. B. wenn der AltText asynchron eintrifft), verwenden Sie BeginTag oder BeginTagEx und rufen Sie anschließend die einzelnen Setter auf

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	Der Typname des Strukturelements, z. B. `Figure`, `Table`, `Span`, `P`. Dieselben Typen, die von BeginTag akzeptiert werden
AltText	Alternativer Text, der in den Eintrag /Alt geschrieben wird (ISO 32000-1 §14.9.3); Zum Auslassen eine leere Zeichenfolge übergeben
ActualText	Tatsächlicher Text, der in den Eintrag /ActualText geschrieben wird (ISO 32000-1 §14.9.4); Zum Auslassen eine leere Zeichenfolge übergeben
Lang	BCP 47-Sprachtag, der in den /Lang-Eintrag geschrieben wird (ISO 32000-1 §14.9.2), z. B. `en-US`, `fr`, `zh-Hant-TW`; Übergeben Sie eine leere Zeichenfolge, um die Dokumentsprache zu erben
Title	Menschenlesbares Label, das in den /T-Eintrag geschrieben wird (ISO 32000-1 §14.7.2); wird im Tags-Navigationsbereich angezeigt; zum Weglassen eine leere Zeichenkette übergeben
ElemID	Eindeutiger Elementbezeichner, der in den Eintrag /ID geschrieben wird (ISO 32000-1 §14.7.4). Muss im Dokument eindeutig sein, wenn er festgelegt ist. Übergeben Sie eine leere Zeichenfolge, um ihn wegzulassen
Expansion	Erweiterung einer Abkürzung oder eines Akronyms, geschrieben in den /E-Eintrag (ISO 32000-1 §14.9.5); übergeben Sie eine leere Zeichenfolge, um dies auszulassen

Return value

Gibt 1 bei Erfolg zurück, 0 wenn kein Dokument ausgewählt ist

Remarks

Rufen Sie EndTag einmal für jeden erfolgreichen BeginTagEx2-Aufruf auf, um das Element vom Tag-Stack zu entfernen; Strukturelemente können verschachtelt sein: Der Aufruf von BeginTagEx2, während ein anderes Element geöffnet ist, erstellt ein Kindelement

Die interne Implementierung ist exakt äquivalent zu:

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

Einzelne Setter bleiben für Eigenschaften verfügbar, die nach dem Öffnen des Elements bestimmt werden, oder für Eigenschaften, die nicht von BeginTagEx2 abgedeckt werden (wie AddTagAttribute für Tabellenzellenattribute)

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;