SetStructElemListNumbering

Tagged PDF, Accessibility

Description

タグスタックで現在開いている構造要素に /ListNumbering 属性（List 属性オーナー）を設定します；この値は、L（リスト）構造要素内の項目に使用されるマーカーまたは番号付けスキームを宣言し、支援技術がリストタイプを正しくアナウンスできるようにします；Owner=List、Name=ListNumbering、およびスキーム名を値として指定して AddTagAttribute を呼び出すのと同等です

Syntax

Delphi

Function TPDFlib.SetStructElemListNumbering(Const Numbering: WideString): Integer;

ActiveX

Function PDFlib::SetStructElemListNumbering(Numbering As String) As Long

DLL

int DLSetStructElemListNumbering(int InstanceID, const wchar_t * Numbering);

Parameters

Numberingリストの番号付けスキーム；大文字小文字を区別し、以下の値のいずれかである必要があります；

None — 視覚的なマーカーなし（属性がない場合のデフォルト）；
Disc — 塗りつぶされた円（•）；
Circle — 白抜きの円（○）；
Square — 塗りつぶされた四角（■）；
Decimal — 1, 2, 3 …；
UpperRoman — I, II, III …；
LowerRoman — i, ii, iii …；
UpperAlpha — A, B, C …；
LowerAlpha — a, b, c …

Return value

成功した場合は 1 を返します；ドキュメントが開かれていないか、現在タグスタックにタグが開かれていない場合は 0 を返します

Remarks

この関数はタグタイプ L（リスト）を指定した BeginTag の後、かつ EndTag の前に呼び出してください；/ListNumbering 属性は ISO 32000-1 §14.8.5.3.2（リスト属性所有者、表 336）で定義されています

属性は個々の LI 項目ではなく、それを含む L 要素に適用されます；L 要素を開いた直後に、その要素に 1 回設定してください；この属性は推奨的なものです：PDF レンダラーによって実際にどのような視覚的マーカーグリフが描画されたかに関わらず、支援技術にこれがどのようなリストであるかを伝え、「箇条書きリスト」や「番号付きリスト」などとアナウンスできるようにします

リストに明示的な番号付けシステムがない場合（たとえば、視覚的な箇条書きマーカーのない一連の用語など）は、None を使用するか、属性を完全に省略します

Example

// An ordered decimal list
PDFlib.BeginTag('L', '', '', '');
PDFlib.SetStructElemListNumbering('Decimal');

  PDFlib.BeginTag('LI', '', '', '');
    PDFlib.BeginTag('Lbl', '', '', '');
    PDFlib.DrawText('1.', 72, 700);
    PDFlib.EndTag;
    PDFlib.BeginTag('LBody', '', '', '');
    PDFlib.DrawText('First item', 90, 700);
    PDFlib.EndTag;
  PDFlib.EndTag;

  PDFlib.BeginTag('LI', '', '', '');
    PDFlib.BeginTag('Lbl', '', '', '');
    PDFlib.DrawText('2.', 72, 680);
    PDFlib.EndTag;
    PDFlib.BeginTag('LBody', '', '', '');
    PDFlib.DrawText('Second item', 90, 680);
    PDFlib.EndTag;
  PDFlib.EndTag;

PDFlib.EndTag; // L

See also

SetStructElemExpansion, AddTagAttribute, BeginTag, EndTag, GetPDFUADiagnostics