mlreportgen.dom.InternalLink class

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

Гиперссылка на местоположение в том же документе

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

Описание

Гиперссылка на местоположение в том же документе, который содержит гиперссылку. Используйте этот вид ссылки, чтобы обеспечить внутреннюю навигацию в рамках документа.

Конструкция

internalLinkObj = InternalLink(targetName,linkText) создает гиперссылку на заданный объект цели ссылки и использует заданный текст ссылки.

internalLinkObj = InternalLink(targetName,linkText,linkTextStyleName) создает гиперссылку на заданную цель ссылки и использует заданное имя стиля для текста ссылки.

internalLinkObj = InternalLink(targetName,textObj) создает гиперссылку на заданную цель с помощью заданного Text объект.

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

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

Имя цели ссылки в виде вектора символов. Вектор символов является значением в Name свойство mlreportgen.dom.LinkTarget возразите или URL.

Текст, чтобы использовать для текста ссылки.

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

Текстовый объект, содержащий текст ссылки, заданный mlreportgen.dom.Text объект.

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

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

Внутренняя ссылка, представленная mlreportgen.dom.InternalLink объект.

Свойства

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

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

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

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

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

Имя стиля ссылок задано в шаблоне в виде вектора символов. Стиль задан styleName должен быть задан в шаблоне, используемом, чтобы создать документ, к которому добавлена ссылка.

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

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

DOM генерирует уникальный для сеанса тег как часть создания этого объекта. Сгенерированный тег имеет форму CLASS:ID, где КЛАСС является классом объекта, и ID является значением Id свойство объекта. Определение вашего собственного значения тега может помочь вам идентифицировать, где проблема произошла во время генерации документов.

Это свойство только для чтения отображает цель ссылки этой гиперссылки.

Методы

Метод

Цель

append

Используйте InternalLink.append похожим способом к тому, как вы используете ExternalLink.append.

Добавьте текст или Textизображение, или CustomElement объект.

clone

Используйте InternalLink.clone похожим способом к тому, как вы используете Paragraph.clone.

Скопируйте внутреннюю ссылку.

Примеры

свернуть все

Соединитесь с целью в том же документе при помощи mlreportgen.dom.LinkTarget объект задать цель ссылки и mlreportgen.dom.InternalLink объект задать ссылку. Имя цели ссылки сопоставляет ссылку с целью ссылки. Чтобы сгенерировать имя цели ссылки, которое допустимо для всех типов отчета, использовать mlreportgen.utils.normalizeLinkID.

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

% Append a link target to a heading
h = Heading(1,'Author''s Biography');
h.Style = {PageBreakBefore(true)};
linkID = normalizeLinkID('bio');
append(h,LinkTarget(linkID));

% Link to the target
append(d,InternalLink(linkID,'About the Author'));

% Append the heading 
append(d,h);

close(d);
rptview(d);

Смотрите также

| |

Темы

Документация MATLAB Report Generator

Поддержка

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