mlreportgen.dom.NumPages class

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

Создайте заполнителя для количества страниц документа

Описание

Создайте заполнителя для количества страниц в документе. Этот объект применяет только к Word и PDF выход. Для Word выход, открывая документ Word заставляет Word заменять этот объект на количество страниц в документе. Для PDF выход API DOM заменяет этот объект на общее количество страниц при записи документа.

Конструкция

num = NumPages() создает объект для общего количества страниц в отчете.

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

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

Общее количество страниц, возвращенных как mlreportgen.dom.NumPages объект.

Свойства

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

Этот дочерний элемент списков свойств только для чтения элементы этого объекта.

Пользовательские атрибуты этого элемента, указанного как массив mlreportgen.dom.CustomAttribute объекты. Используйте пользовательские атрибуты, поддержанные выходным форматом.

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

Это списки свойств только для чтения родительский элемент этого элемента документа.

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

DOM генерирует уникальный для сеанса тег, когда он создает элемент документа. Структурируйте тег как class:id, где class класс элемента и id значение Id свойство. Можно задать тег, чтобы заменить сгенерированный тег. Определение вашего собственного тега может облегчить идентифицировать, где проблема произошла во время генерации документов.

Объекты формата, которые задают формат элемента документа.

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

Методы

Метод

Цель

clone

Скопируйте этот объект.

Примеры

свернуть все

Этот пример вставляет общее количество страниц документа в нижнем колонтитуле. Используйте этот класс, чтобы отобразить текущий номер страницы наряду с общим количеством страниц, таких как Страница 1 3.

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

% Create page footer
footer = DOCXPageFooter('default');
d.CurrentPageLayout.PageFooters = footer;

% Define page number and add to footer.
d.CurrentPageLayout.FirstPageNumber = 1;
t = Text('Page ');
t.WhiteSpace = 'preserve';
t1 = Text(' of ');
t1.WhiteSpace = 'preserve';
pageinfo = Paragraph();
pageinfo.HAlign = 'center';
append(pageinfo,t);
append(pageinfo,Page());
append(pageinfo,t1);
append(pageinfo,NumPages());
append(footer,pageinfo);

% Create several pages.
p = Paragraph('Hello World');
append(d,p);
p = Paragraph('Another page');
p.Style = {PageBreakBefore(true)};
append(d,p);
append(d,clone(p));

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

Введенный в R2016a