mlreportgen.dom.LinkTarget class

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

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

Описание

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

Конструкция

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

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

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

Имя цели ссылки в виде вектора символов или строкового скаляра.

Примечание

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

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

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

  • Одним словом, сообщите, задайте закладку Word.

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

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

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

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

Свойства

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

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

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

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

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

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

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

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

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

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

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