SetStructElemAltTextA

タグ付き PDF & アクセシビリティ

説明

末尾の A は ANSI（char）DLL エントリポイントを示し、ActiveX/COM の表面では Unicode 形式のみ公開される。動作は SetStructElemAltText と同一で、文字列引数は現在の SetAnsiMode コードページを使って解釈される

タグスタックで現在構築中の構造要素に /Alt エントリを設定します代替テキストは、画像、図、数式など、要素を視覚的にレンダリングできないときに支援技術 (スクリーンリーダー、点字ディスプレイ) がユーザーへ提示するテキスト説明です

この関数は、空でない AltText 引数を BeginTag または BeginTagEx に渡すことと同等ですが、要素を開いた後に代替テキストを設定または更新できます。要素型が判明した後で説明を非同期に計算または取得する場合に便利です

構文

Delphi

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

DLL

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

パラメータ

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 構造要素に代替説明を要求します。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;

SetStructElemAltTextA

説明

構文

Delphi

DLL

パラメータ

戻り値

備考

例

関連項目