Exponenta Banner

mlreportgen.dom.NumPages class

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

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

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

Описание

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

Конструкция

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

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

расширить все

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

Свойства

расширить все

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

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

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

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

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

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

MATLAB Report Generator

Поддержка