mlreportgen.dom.PageRef class

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

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

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

Описание

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

Совет

Используйте этот объект для генерации ссылок на страницы, например «Для получения дополнительной информации см. страницу 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

MATLAB Report Generator

Поддержка

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