SetStructElemListNumberingA

Структурированный PDF, Доступность

Описание

Завершающая A обозначает точку входа DLL типа ANSI (char); интерфейс ActiveX/COM предоставляет только форму Unicode. Поведение идентично SetStructElemListNumbering, а строковые аргументы интерпретируются с использованием текущей кодовой страницы SetAnsiMode

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

Синтаксис

Delphi

Function DLSetStructElemListNumberingA(InstanceID: Integer; Numbering: PAnsiChar): Integer;

DLL

int DLSetStructElemListNumberingA(int InstanceID, const char * Numbering);

Параметры

NumberingThe list numbering scheme. Must be one of the following values (case-sensitive):

None — no visible marker (default when attribute is absent)
Disc — filled circle (•)
Circle — open circle (○)
Square — filled square (■)
Decimal — 1, 2, 3 …
UpperRoman — I, II, III …
LowerRoman — i, ii, iii …
UpperAlpha — A, B, C …
LowerAlpha — a, b, c …

Возвращаемое значение

Возвращает 1 в случае успеха, 0 — если документ не открыт или на стеке тегов нет открытого тега

Примечания

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

Атрибут относится к содержащему элементу L, а не к отдельным пунктам LI. Задайте его один раз на элементе L сразу после открытия. Атрибут носит рекомендательный характер: он сообщает ассистивной технологии, что это за список, чтобы она могла озвучить «маркированный список», «нумерованный список» и так далее — независимо от того, какие видимые значки фактически нарисовал рендер PDF.

Если у списка нет явной системы нумерации (например, перечня терминов без видимых маркеров), используйте None или вовсе опустите атрибут

Пример

// 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

См. также

SetStructElemExpansion, AddTagAttribute, BeginTag, EndTag, GetPDFUADiagnostics