SetStructElemAltText

標籤式 PDF 與無障礙

描述

在標籤堆疊目前建構中的結構元素上設定 /Alt 項目。替代文字是元素無法以視覺呈現時（例如影像、圖形或數學公式），輔助技術（螢幕閱讀器、點字顯示器）向使用者朗讀的文字描述。

此函式等同對 BeginTag 或 BeginTagEx 傳入非空 AltText 參數，但允許在元素開啟之後才設定或更新替代文字。元素類型確定之後，描述才非同步算出或取得時，這就很實用。

語法

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

參數

傳回值

成功傳回 1；目前沒有開啟中的結構元素或未選取文件時傳回 0

備註

在 BeginTag 之後、目標元素位於標籤堆疊頂端時立即呼叫此函式，或在對應的 EndTag 呼叫之前的任何時點呼叫。

AltText 與 ActualText 用途不同。AltText 是整個元素的完整文字替代 — 為無法感知呈現結果的使用者取代視覺內容。ActualText（ISO 32000-1 §14.9.4）為內嵌字符直接擷取會出錯的情況（例如連字）提供精確的 Unicode 字元序列，且不取代呈現。螢幕閱讀器對 Figure 與 Formula 元素通常朗讀 AltText，並用 ActualText 做字元層級修正。

ISO 32000-1 §14.9.3 定義 /Alt 項目。PDF/UA-1（ISO 14289-1 §7.5）要求 Figure 與 Formula 結構元素要有替代描述。Figure 或 Formula 元素缺少 Alt 文字時，GetPDFUADiagnostics 會回報 FIGURE-NO-ALT:N 問題代碼。

範例

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

另見

BeginTag, BeginTagEx, SetStructElemActualText, SetStructElemLang, GetPDFUADiagnostics