Exponenta Banner

mlreportgen.dom.PageRef class

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

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

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

Описание

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

Совет

Используйте этот объект сгенерировать постраничные справочники, такие как "Страница 15 See для получения дополнительной информации".

Конструкция

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

Входные параметры

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

Имя цели ссылки к ссылке в виде вектора символов. Задайте цель с помощью LinkTarget объект.

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

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

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

Свойства

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

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

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

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

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

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

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

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

DOM генерирует уникальный для сеанса тег как часть создания этого объекта. Сгенерированный тег имеет форму CLASS:ID, где КЛАСС является классом объекта, и 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

Поддержка