mlreportgen.dom.LinkTarget class

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

Цель для внутренних или внешних ссылок или звеньев области изображения

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

Описание

Цель, используемая для внутренних и внешних ссылок и для ссылок на область изображений. Можно задать LinkTarget объект при построении mlreportgen.dom.InternalLink или mlreportgen.dom.ImageArea объект.

Конструкция

targetObj = LinkTarget(name) создает ссылку цель с заданным именем.

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

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

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

Примечание

Чтобы сгенерировать целевое имя ссылки, допустимое для всех типов отчетов, используйте mlreportgen.utils.normalizeLinkID. Сгенерированное имя соответствует Microsoft® Ограничение слова на длину идентификатора и требование PDF, чтобы идентификатор начинался с буквенного символа.

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

Чтобы настроить цель ссылки для внешней ссылки:

  • В отчете Word укажите закладку Word.

  • В HTML отчете задайте HTML с именем якорь (для примера, <a name='appendix'/>).

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

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

Ссылка на цель, представленная mlreportgen.dom.LinkTarget объект.

Свойства

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

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

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

См. name входной параметр.

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

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

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

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

Методы

Метод

Цель

append

Добавьте содержимое в конечный объект связи.

clone

Использование LinkTarget.clone способом, подобным тому, как вы используете Paragraph.clone.

Скопируйте конечный объект ссылки.

Примеры

свернуть все

Задайте цель ссылки в верхней части отчета и добавьте внутреннюю ссылку к этой цели.

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

p = Paragraph('This is my paragraph');
linkID = normalizeLinkID('home');
append(p,LinkTarget(linkID));
append(d,p);

p = Paragraph('This is another paragraph');
p.Style = {PageBreakBefore(true)};
append(d,p);
append(d,InternalLink(linkID,'Go to Top'));

close(d);
rptview(d);

Вопросы совместимости

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

См. также

| | | |

Темы

MATLAB Report Generator

Поддержка

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