exponenta event banner

класс mlreportgen.dom.PageRef

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

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

Описание

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

Совет

Этот объект используется для создания ссылок на страницы, например «См. страницу 15 для получения дополнительных сведений».

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

pageRef = PageRef(target) создает объект ссылки на страницу, который ссылается на указанный LinkTarget объект. Генерация выходных данных заменяет PageRef с номером страницы, содержащей указанный целевой объект.

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

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

Имя целевого объекта ссылки, указанного как символьный вектор. Укажите цель с помощью LinkTarget объект.

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

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

Имя целевого объекта ссылки, возвращаемое как mlreportgen.dom.PageRef объект. Это PageRef объект заменяется номером страницы, содержащей указанный LinkTarget объект.

Свойства

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

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

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

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

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

Форматирование объектов, задающих формат элемента документа.

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

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

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

Имя цели ссылки на эту страницу, указанное как символьный вектор.

Методы

Метод

Цель

clone

Копировать этот объект.

Примеры

свернуть все

В этом примере на другую страницу вставляется ссылка на номер страницы. Добавление целевого объекта mytarget использование LinkTarget. Использовать PageRef для обращения к странице, содержащей целевой объект mytarget.

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

% Create page footer and add page number to it
footer = PDFPageFooter('default');
d.CurrentPageLayout.PageFooters = footer;
d.CurrentPageLayout.FirstPageNumber = 1;
pageno = Paragraph();
pageno.HAlign = 'center';
append(pageno,Page());
append(footer,pageno);

% Add target to heading object and append heading and para text to document
h = Heading1(LinkTarget('mytarget'));
append(h,'Head Whose Page to Reference');
p = Paragraph('Here is some paragraph text.');
append(d,h);
append(d,p);

% Add another page and insert page reference to target
p1 = Paragraph('The following paragraph contains the page reference.');
p1.Style = {PageBreakBefore(true)};
p2 = Paragraph('See Page ');
p2.WhiteSpace = 'preserve';
ref = PageRef('mytarget');
append(p2,ref);
append(p2,'.');
append(d,p1);
append(d,p2);

close(d);
rptview(d.OutputPath);
Представлен в R2016a