SetStructElemAltText

Tagged PDF & Accessibility

Description

Legt den Eintrag /Alt für das Strukturelement fest, das derzeit auf dem Tag-Stapel erstellt wird; Alternativtext ist die Textbeschreibung, die assistierende Technologien (Screenreader, Braille-Zeilen) Benutzern präsentieren, wenn das Element nicht visuell gerendert werden kann — zum Beispiel ein Bild, eine Grafik oder eine mathematische Formel

Diese Funktion ist äquivalent zur Übergabe eines nicht leeren AltText-Arguments an BeginTag oder BeginTagEx, ermöglicht jedoch das Festlegen oder Aktualisieren des Alternativtexts, nachdem das Element geöffnet wurde. Sie 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);

Parameters

AltText	Die alternative Textbeschreibung, die dem aktuellen Strukturelement zugeordnet werden soll. Übergeben Sie eine leere Zeichenfolge, um einen zuvor festgelegten Wert zu löschen

Return value

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

Remarks

Rufen Sie diese Funktion unmittelbar nach BeginTag auf, während sich das Zielelement oben auf dem Tag-Stack befindet, oder zu einem beliebigen Zeitpunkt vor dem entsprechenden EndTag-Aufruf

AltText und ActualText dienen unterschiedlichen Zwecken; AltText ist ein vollständiger textueller Ersatz für das gesamte Element — es ersetzt den visuellen Inhalt für Benutzer, die das gerenderte Ergebnis nicht wahrnehmen können; ActualText (ISO 32000-1 §14.9.4) liefert die exakte Unicode-Zeichenfolge für Inline-Glyphen, deren extrahierter Text andernfalls falsch wäre (wie z. B. Ligaturen), und ersetzt das Rendern nicht; Screenreader sprechen normalerweise AltText für Figure- und Formula-Elemente und verwenden ActualText für Korrekturen auf Zeichenebene

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

Example

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