SetStructElemAltText

Tagged PDF & Barrierefreiheit

Beschreibung

Legt den Eintrag /Alt für das Strukturelement fest, das aktuell im Tag-Stack erstellt wird. Alternativtext ist die Textbeschreibung, die Hilfstechnologien wie Screenreader und Braillezeilen Benutzern präsentieren, wenn das Element nicht visuell gerendert werden kann, beispielsweise ein Bild, eine Figur oder eine mathematische Formel

Diese Funktion entspricht der Übergabe eines nicht leeren Arguments AltText an BeginTag oder BeginTagEx, ermöglicht jedoch das Festlegen oder Aktualisieren des Alternativtexts nach dem Öffnen des Elements. Dies ist nützlich, wenn die Beschreibung nach Bekanntwerden des Elementtyps asynchron berechnet oder abgerufen wird

Syntax

Delphi

Function TPDFlib.SetStructElemAltText(Const AltText: WideString): Integer;

ActiveX

Function PDFlib::SetStructElemAltText(AltText As String) As Long

DLL

int DLSetStructElemAltText(int InstanceID, const wchar_t * AltText);

Parameter

AltText	Die alternative Textbeschreibung, die dem aktuellen Strukturelement zugeordnet werden soll. Ü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

Rufen Sie diese Funktion unmittelbar nach BeginTag auf, während sich das Zielelement oben im Tag-Stapel befindet, oder jederzeit vor dem passenden Aufruf von EndTag

AltText und ActualText erfüllen unterschiedliche Zwecke. AltText ist ein vollständiger Textersatz für das gesamte Element — er ersetzt den visuellen Inhalt für Benutzer, die die gerenderte Ausgabe nicht wahrnehmen können. ActualText (ISO 32000-1 §14.9.4) liefert die genaue Unicode-Zeichenfolge für Inline-Glyphen, deren extrahierter Text sonst falsch wäre (etwa Ligaturen), und ersetzt das Rendering nicht. Bildschirmleseprogramme sprechen bei Figure- und Formula-Elementen typischerweise AltText und verwenden ActualText für Korrekturen auf Zeichenebene.

ISO 32000-1 §14.9.3 definiert den Eintrag /Alt. PDF/UA-1 (ISO 14289-1 §7.5) verlangt alternative Beschreibungen für Figure- und Formula-Strukturelemente. GetPDFUADiagnostics meldet den Problemcode FIGURE-NO-ALT:N, wenn Figure- oder Formula-Elementen Alt-Text fehlt.

Beispiel

// Tag an embedded chart image with alternative text
PDFlib.BeginTag('Figure', '', '');
PDFlib.SetStructElemAltText('Bar chart: Q1 sales 120, Q2 sales 145, Q3 sales 98');
PDFlib.SetStructElemBBox(x, y, x + w, y + h);
PDFlib.DrawImage(imgHandle, x, y, w, h);
PDFlib.EndTag;

Siehe auch

BeginTag, BeginTagEx, SetStructElemActualText, SetStructElemLang, GetPDFUADiagnostics