exponenta event banner

класс mlreportgen.dom.PageNumber

Пакет: mlreportgen.dom
Суперклассы:

Форматирование номеров страниц

Описание

Задает начальное значение номера страницы в макете страницы Word и тип номера, например, римские цифры. Задать это свойство как стиль для DOCXPageLayout или PDFPageLayout объект. Вставка номера страницы в объект макета страницы с помощью mlreportgen.dom.Page чтобы увидеть эффект этого формата.

Этот объект позволяет создать составные номера страниц в форме [Глава #] - [Страница #] и указать разделитель. Пример см. в разделе Добавление сложных номеров страниц в Microsoft Word.

Строительство

pgnum = PageNumber() указывает числовой номер страницы, значение которого продолжается от предыдущей страницы.

pgnum = PageNumber(number) устанавливает начальное значение в указанное число.

pgnum = PageNumber(number,format) использует указанный тип числа, например римские цифры.

Входные аргументы

развернуть все

Число первых страниц в этом макете, указанное как положительное целое число.

Тип используемой нумерации страниц, указанный в качестве одного из этих значений.

СтоимостьЗначениеПрименяется к
DOCXPDF
'a'Строчная буква
'A'Буква в верхнем регистре
'i'Строчные римские цифры
'I'Прописные римские цифры
'n'. 'N' , '1', 'decimal'Арабские цифры
'numberInDash'Число с тире с обеих сторон 
'hebrew1'Еврейские цифры 
'hebrew2'Еврейский алфавит 
'arabicAlpha'Арабский алфавит 
'arabicAbjad'Арабские абджадские цифры 
'thaiLetters'Тайские письма 
'thaiNumbers'Тайские цифры  
'thaiCounting'Тайская система счёта 

Выходные аргументы

развернуть все

Формат номера страницы, возвращенный как mlreportgen.dom.PageNumber объект.

Свойства

развернуть все

Символ, используемый для отделения номера главы от номера страницы, указанного как одно из следующих значений:

  • 'colon' или ';'- Двоеточие.

  • 'hyphen' или '-'- Дефис.

  • 'emdash'- Эм тире (-).

  • 'endash'- En тире (-).

  • 'period' или '.'- Период.

Стиль Level of Heading, используемый в разделах, указывается как вектор положительных целых символов.

Тип используемой нумерации страниц, указанный как один из векторов символов или строковых скаляров в таблице.

СтоимостьЗначениеПрименяется к
DOCXPDF
'a'Строчная буква
'A'Буква в верхнем регистре
'i'Строчные римские цифры
'I'Прописные римские цифры
'n'. 'N', '1', 'decimal'Арабские цифры
'numberInDash'Число с тире с обеих сторон 
'hebrew1'Еврейские цифры 
'hebrew2'Еврейский алфавит 
'arabicAlpha'Арабский алфавит 
'arabicAbjad'Арабские абджадские цифры 
'thaiLetters'Тайские письма 
'thaiNumbers'Тайские цифры  
'thaiCounting'Тайская система счёта 

Идентификатор для этого элемента документа, указанный как вектор символов или скаляр строки. При создании элемента документа DOM создает уникальный идентификатор сеанса. Можно указать собственный идентификатор.

Значение номера первой страницы в этом макете, указанное как положительное целое число.

Тег для этого элемента документа, заданный как вектор символов или скаляр строки.

DOM создает уникальный для сеанса тег как часть создания этого объекта. Созданный тег имеет вид CLASS: ID, где CLASS - класс объекта, а ID - значение Id свойства объекта. Указание собственного значения тега может помочь определить, где возникла проблема во время создания документа.

Примеры

свернуть все

В этом примере показан синтаксис использования PageNumber, которые задаются с помощью PageNumber как стиль в текущем макете страницы. Чтобы нумерация вступила в силу, необходимо вставить номер страницы в нижний колонтитул страницы или верхний колонтитул с помощью Pageи необходимо использовать многоуровневый стиль списка в шаблоне Word. Полный пример см. в разделе Добавление сложных номеров страниц в Microsoft Word

import mlreportgen.dom.*;
d = Document('mypages','docx');

open(d);
layout = d.CurrentPageLayout;

% Start on page 7 and use roman numerals
pagenumber = PageNumber(7,'I');

% Add page number object to page layout styles
layout.Style = [layout.Style {pagenumber}];

% Create the footer and add a page number to it
myfooter = DOCXPageFooter();
para = Paragraph();
para.HAlign = 'center';
append(para,Page());

% Add the page number to the footer
append(myfooter,para);
layout.PageFooters = myfooter;

% Add content
append(d,'Hello World')';

close(d);
rptview(d.OutputPath);