SetStructElemTitleA

Tagged PDF & Barrierefreiheit

Beschreibung

Das angehängte A bezeichnet den ANSI-DLL-Einstiegspunkt (char); die ActiveX/COM-Oberfläche stellt nur die Unicode-Form bereit. Das Verhalten ist mit SetStructElemTitle identisch, und Zeichenfolgenargumente werden anhand der aktuellen SetAnsiMode-Codeseite interpretiert

Legt den Eintrag /T (Titel) des Strukturelements fest, das gerade auf dem Tag-Stapel aufgebaut wird. Der Titel ist eine menschenlesbare Bezeichnung, die das konkrete Element charakterisiert — beispielsweise Kapitel 1, Übersichtstabelle oder Abbildung 3: Quartalsumsatz — und nicht lediglich den Elementtyp wiederholt

Syntax

Delphi

Function DLSetStructElemTitleA(InstanceID: Integer; Title: PAnsiChar): Integer;

DLL

int DLSetStructElemTitleA(int InstanceID, const char * Title);

Parameter

Title	Eine lesbare Textzeichenfolge zur Kennzeichnung dieser konkreten Elementinstanz. Übergeben Sie eine leere Zeichenfolge, um einen zuvor festgelegten Wert zu löschen

Rückgabewert

Gibt bei Erfolg 1 oder 0 zurück, wenn derzeit kein Strukturelement geöffnet oder kein Dokument ausgewählt ist

Anmerkungen

Der Eintrag /T ist in ISO 32000-1 §14.7.2 Tabelle 324 definiert. Er wird als PDF-Textzeichenfolge in das Strukturelementwörterbuch geschrieben.

Title erfüllt einen anderen Zweck als die übrigen Texteigenschaften eines Strukturelements:

/T (Title) — Eine beschreibende Bezeichnung für das Element, wie sie in Navigations- und Tag-Bereichen verwendet wird. Geeignet für Abschnittsüberschriften, Tabellen- und Abbildungsbeschriftungen
/Alt (siehe SetStructElemAltText) — Ein vollständiger textlicher Ersatz des Elements für assistive Technologien, wenn das Element nicht gerendert werden kann
/ActualText (siehe SetStructElemActualText) — Ein exakter Unicode-Ersatz für Glyphenfolgen, deren extrahierter Text falsch wäre

PDF-Viewer verwenden /T zur Bezeichnung von Elementen im Tag-Navigationsbereich. Barrierefreiheitswerkzeuge und Reparatursoftware verwenden es als Orientierungstitel für die Dokumentnavigation. Bei Überschriftselementen (H1–H6) dient der Elementinhalt selbst als Überschriftentext; /T ist nützlicher für Nichttextelemente (Table, Figure, Form) oder Container (Sect, Div), die eine beschreibende Bezeichnung benötigen

Beispiel

// Tag a data table with a title for navigation and accessibility tools
PDFlib.BeginTag('Table', '', '');
PDFlib.SetStructElemTitle('Table 2: Annual Revenue by Region');
// ... table rows and cells
PDFlib.EndTag;

// Tag a document section
PDFlib.BeginTag('Sect', '', '');
PDFlib.SetStructElemTitle('Chapter 3: Implementation');
// ... section content
PDFlib.EndTag;

Siehe auch

BeginTag, SetStructElemAltText, SetStructElemActualText, SetStructElemID, GetPDFUADiagnostics