SetStructElemTitleA

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

説明

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

タグスタックで現在構築中の構造要素に /T(タイトル)エントリを設定します。タイトルは単に要素形式を繰り返すのではなく、Chapter 1、Summary Table、Figure 3: Quarterly Sales など、特定の要素を特徴付ける人間が読めるラベルです

構文

Delphi

Function DLSetStructElemTitleA(InstanceID: Integer; Title: PAnsiChar): Integer;

DLL

int DLSetStructElemTitleA(int InstanceID, const char * Title);

パラメータ

Titleこの特定の要素インスタンスを識別する人間が読めるテキスト文字列。以前に設定した値を消去するには空文字列を渡す

戻り値

成功時は 1、現在開いている構造要素がないか文書が選択されていない場合は 0 を返します

備考

/T エントリは ISO 32000-1 §14.7.2 Table 324 で定義されています。構造要素辞書に PDF テキスト文字列として書き込まれます

Title は構造要素の他のテキストプロパティとは異なる目的を果たします:

PDF ビューアーは /T を使用して Tags ナビゲーションパネル内の要素にラベルを付けます。アクセシビリティツールと修復ソフトウェアは、文書ナビゲーション用のランドマークタイトルとしてこれを使用します。見出し要素 (H1–H6) では要素の内容自体が見出しテキストになります。/T は、説明ラベルが必要な非テキスト要素 (Table、Figure、Form) またはコンテナー (Sect、Div) でより有用です

例

// Tag a data table with a title for navigation and accessibility tools
PDFlib.BeginTag('Table', '', '');
PDFlib.SetStructElemTitle('Table 2: Annual Revenue by Region');
// ... table rows and cells
PDFlib.EndTag;

// Tag a document section
PDFlib.BeginTag('Sect', '', '');
PDFlib.SetStructElemTitle('Chapter 3: Implementation');
// ... section content
PDFlib.EndTag;

関連項目

BeginTag, SetStructElemAltText, SetStructElemActualText, SetStructElemID, GetPDFUADiagnostics