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 объекты. Пользовательские атрибуты должны поддерживаться форматом выхода.

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

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

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

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

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

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

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

Методы

Метод

Цель

append

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

Добавить текст или Text, Image, или 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

Поддержка

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