SetStructElemAltTextA

Tagged PDF i dostępność

Opis

Końcowa litera A oznacza punkt wejścia DLL ANSI (char); powierzchnia ActiveX/COM udostępnia wyłącznie postać Unicode. Zachowanie jest identyczne jak w SetStructElemAltText, a argumenty ciągów są interpretowane przy użyciu bieżącej strony kodowej SetAnsiMode

Ustawia wpis /Alt w elemencie struktury aktualnie tworzonym na stosie tagów. Tekst alternatywny jest opisem tekstowym prezentowanym użytkownikom przez technologię asystującą (czytniki ekranu, monitory brajlowskie), gdy elementu nie można wyrenderować wizualnie — na przykład obrazu, ilustracji lub wzoru matematycznego

Ta funkcja odpowiada przekazaniu niepustego argumentu AltText do BeginTag lub BeginTagEx, lecz pozwala ustawić lub zaktualizować tekst alternatywny po otwarciu elementu. Jest przydatna, gdy opis jest obliczany lub pobierany asynchronicznie po ustaleniu typu elementu

Składnia

Delphi

Function DLSetStructElemAltTextA(InstanceID: Integer; AltText: PAnsiChar): Integer;

DLL

int DLSetStructElemAltTextA(int InstanceID, const char * AltText);

Parametry

Wartość zwracana

Zwraca 1 w przypadku powodzenia albo 0, gdy żaden element struktury nie jest obecnie otwarty lub nie wybrano dokumentu

Uwagi

Wywołaj tę funkcję bezpośrednio po BeginTag, gdy element docelowy znajduje się na szczycie stosu znaczników, albo w dowolnym momencie przed odpowiadającym wywołaniem EndTag

AltText i ActualText służą do różnych celów. AltText jest pełnym tekstowym zamiennikiem całego elementu — zastępuje zawartość wizualną dla użytkowników, którzy nie mogą odczytać wyrenderowanego wyniku. ActualText (ISO 32000-1 §14.9.4) podaje dokładną sekwencję znaków Unicode dla glifów osadzonych w tekście, których wyodrębnienie byłoby nieprawidłowe (na przykład ligatur), i nie zastępuje renderowania. Czytniki ekranu zwykle odczytują AltText dla elementów Figure i Formula, a ActualText wykorzystują do korekt na poziomie znaków

ISO 32000-1 §14.9.3 definiuje wpis /Alt. PDF/UA-1 (ISO 14289-1 §7.5) wymaga opisów alternatywnych dla elementów struktury Figure i Formula. GetPDFUADiagnostics zgłasza kod problemu FIGURE-NO-ALT:N, gdy elementy Figure lub Formula nie mają tekstu Alt

Przykład

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

Zobacz również

BeginTag, BeginTagEx, SetStructElemActualText, SetStructElemLang, GetPDFUADiagnostics