SetStructElemListNumbering

Tagged PDF, Accessibility

Description

Устанавливает атрибут /ListNumbering (владелец атрибута List) для структурного элемента, открытого в данный момент в стеке тегов; значение объявляет схему маркеров или нумерации, используемую для элементов в структурном элементе L (список), что позволяет вспомогательным технологиям правильно объявлять тип списка; эквивалентно вызову AddTagAttribute с параметрами Owner=List, Name=ListNumbering и названием схемы в качестве значения

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

Returns 1 on success. Returns 0 if no document is open or no tag is currently open on the tag stack.

Remarks

Вызывайте эту функцию после BeginTag с типом тега L (список) и перед EndTag; атрибут /ListNumbering определен в ISO 32000-1 §14.8.5.3.2 (владелец атрибута List, таблица 336)

Атрибут применяется к содержащему элементу L, а не к отдельным элементам LI; установите его один раз для элемента L сразу после его открытия; атрибут является рекомендательным: он сообщает вспомогательным технологиям, что это за тип списка, чтобы они могли объявить "маркированный список", "нумерованный список" и т. д. — независимо от того, какие глифы визуальных маркеров были фактически отрисованы рендерером 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