BeginTagEx2

Tagged PDF & Barrierefreiheit

Beschreibung

Öffnet ein neues Strukturelement und legt es auf den Tag-Stack, wobei alle wesentlichen Elementeigenschaften in einem einzigen Aufruf festgelegt werden. BeginTagEx2 ist ein Komfort-Wrapper für BeginTagEx, gefolgt von SetStructElemTitle, SetStructElemID und SetStructElemExpansion. Die Übergabe einer leeren Zeichenfolge für Title, ElemID oder Expansion überspringt den entsprechenden Setter; die übrigen Parameter verhalten sich identisch zu BeginTagEx

Verwenden Sie BeginTagEx2, wenn alle beschreibenden Eigenschaften eines Elements bereits beim Öffnen bekannt sind, um mehrere aufeinanderfolgende Setter-Aufrufe zu vermeiden. Wird eine Eigenschaft später bestimmt, beispielsweise wenn 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);

Parameter

TagType	Der Typname des Strukturelements, z. B. `Figure`, `Table`, `Span`, `P`. Es gelten dieselben von BeginTag akzeptierten Typen.
AltText	Alternativer Text, der nach ISO 32000-1 §14.9.3 in den Eintrag /Alt geschrieben wird. Zum Auslassen eine leere Zeichenfolge übergeben
ActualText	Tatsächlicher Text, der in den Eintrag /ActualText geschrieben wird (ISO 32000-1 §14.9.4). Übergeben Sie zum Auslassen eine leere Zeichenfolge
Lang	BCP 47-Sprach-Tag, das in den Eintrag /Lang nach ISO 32000-1 §14.9.2 geschrieben wird, beispielsweise `en-US`, `fr` oder `zh-Hant-TW`. Eine leere Zeichenfolge übergeben, um die Dokumentsprache zu übernehmen
Title	Menschenlesbare Bezeichnung, die in den Eintrag /T geschrieben wird (ISO 32000-1 §14.7.2). Wird im Tags-Navigationsfeld angezeigt. Übergeben Sie eine leere Zeichenfolge, um sie auszulassen.
ElemID	Eindeutige Elementkennung, die in den Eintrag /ID geschrieben wird (ISO 32000-1 §14.7.4). Wenn gesetzt, muss sie innerhalb des Dokuments eindeutig sein. Übergeben Sie eine leere Zeichenfolge, um sie auszulassen.
Expansion	Ausgeschriebene Form einer Abkürzung oder eines Akronyms, die in den Eintrag /E geschrieben wird (ISO 32000-1 §14.9.5). Zum Auslassen eine leere Zeichenfolge übergeben.

Rückgabewert

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

Anmerkungen

Rufen Sie EndTag einmal für jeden erfolgreichen Aufruf von BeginTagEx2 auf, um das Element vom Tag-Stapel zu entfernen. Strukturelemente können verschachtelt werden: Ein Aufruf von BeginTagEx2 bei geöffnetem anderem Element erstellt ein Kindelement.

Die interne Implementierung entspricht exakt Folgendem:

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 erst nach dem Öffnen des Elements bestimmt werden, oder für Eigenschaften, die BeginTagEx2 nicht abdeckt, beispielsweise AddTagAttribute für Tabellenzellenattribute

Beispiel

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

Siehe auch

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion