mlreportgen.dom.PageNumber class

Пакет: 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'- Em dash (-).

  • 'endash'- En dash (-).

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

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

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

ЗначениеЗначениеПрименяется к
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);

См. также

| | | |

Темы

MATLAB Report Generator

Поддержка

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