exponenta event banner

класс mlreportgen.dom.NumPages

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

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

Описание

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

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

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