BeginTagEx2

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

説明

新しい構造要素を開いてタグスタックにプッシュし、主要な要素プロパティを 1 回の呼び出しで設定します。BeginTagEx2 は、BeginTagEx に続けて SetStructElemTitle、SetStructElemID、SetStructElemExpansion を呼び出す便利なラッパーです。Title、ElemID、Expansion のいずれかに空文字列を渡すと対応する setter を省略します。その他のパラメータは BeginTagEx と同じ動作をします

要素を開く時点ですべての説明プロパティが判明している場合は、setter 呼び出しの連続を避けるため BeginTagEx2 を使用します。プロパティが後で決まる場合（たとえば AltText が非同期で届く場合）は、BeginTag または BeginTagEx を使用し、その後に個別の setter を呼び出します

構文

Delphi

Function TPDFlib.BeginTagEx2(Const TagType, AltText, ActualText, Lang, Title, ElemID, Expansion: WideString): Integer;

ActiveX

Function PDFlib::BeginTagEx2(TagType As String, AltText As String, ActualText As String, Lang As String, Title As String, ElemID As String, Expansion As String) As Long

DLL

int DLBeginTagEx2(int InstanceID, const wchar_t * TagType, const wchar_t * AltText, const wchar_t * ActualText, const wchar_t * Lang, const wchar_t * Title, const wchar_t * ElemID, const wchar_t * Expansion);

パラメータ

TagType構造要素のタイプ名（例: Figure、Table、Span、P）。BeginTag で受け入れられるタイプと同じです
AltText/Alt エントリに書き込む代替テキスト（ISO 32000-1 §14.9.3）。省略するには空文字列を渡す
ActualText/ActualText エントリに書き込む実際のテキスト（ISO 32000-1 §14.9.4）。省略する場合は空文字列を渡します
Lang/Lang エントリに書き込む BCP 47 言語タグ (ISO 32000-1 §14.9.2) です。例: en-US、fr、zh-Hant-TW。文書の言語を継承するには空文字列を渡します
Title/T エントリに書き込む人が読めるラベル（ISO 32000-1 §14.7.2）。Tags ナビゲーションパネルに表示されます。省略する場合は空文字列を渡します
ElemID/ID エントリへ書き込む一意の要素識別子（ISO 32000-1 §14.7.4）。設定する場合は文書内で一意でなければなりません。省略するには空文字列を渡します
Expansion/E エントリに書き込む略語または頭字語の展開形（ISO 32000-1 §14.9.5）。省略する場合は空文字列を渡します

戻り値

成功時は 1、ドキュメントが選択されていない場合は 0 を返す

備考

EndTag は成功した各 BeginTagEx2 呼び出しにつき 1 回呼び出し、要素をタグスタックから取り出します。構造要素はネストでき、別の要素が開いている間に BeginTagEx2 を呼び出すと子要素が作成されます

内部実装は次と完全に同等です:

BeginTagEx(TagType, AltText, ActualText, Lang);
if Title <> '' then SetStructElemTitle(Title);
if ElemID <> '' then SetStructElemID(ElemID);
if Expansion <> '' then SetStructElemExpansion(Expansion);

要素を開いた後に決定されるプロパティ、または BeginTagEx2 で扱わないプロパティ（表セル属性用の AddTagAttribute など）には、個別セッターを引き続き使用できます

例

// Tag a figure with all descriptive properties in one call
PDFlib.BeginTagEx2(
  'Figure',                              // TagType
  'Bar chart: Q1 120, Q2 145, Q3 98',   // AltText
  '',                                    // ActualText (not needed for images)
  '',                                    // Lang (inherit document language)
  'Figure 3: Quarterly Sales',           // Title
  'fig-quarterly-sales',                 // ElemID
  ''                                     // Expansion (not an abbreviation)
);
PDFlib.SetStructElemBBox(x, y, x + w, y + h);
PDFlib.DrawImage(imgHandle, x, y, w, h);
PDFlib.EndTag;

// Tag an acronym span with its expansion
PDFlib.BeginTagEx2(
  'Span',
  '',                                          // AltText
  '',                                          // ActualText
  '',                                          // Lang
  '',                                          // Title
  '',                                          // ElemID
  'World Wide Web Consortium'                  // Expansion
);
PDFlib.WriteText('W3C');
PDFlib.EndTag;

関連項目

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion