mlreportgen.dom.EmbeddedObject class

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

Встраивание файла в документ

Описание

Используйте объект mlreportgen.dom.EmbeddedObject класс для встраивания файла в документ. Преимущество встраивания файла в документ, вместо ссылки на него, заключается в том, что вы можете перемещать документ, не перемещая целевой файл.

Можно добавить mlreportgen.dom.EmbeddedObject объект объектам этих классов DOM:

mlreportgen.dom.Document
mlreportgen.dom.DocumentPart
mlreportgen.dom.Paragraph
mlreportgen.dom.TableEntry
mlreportgen.dom.TableHeaderEntry
mlreportgen.dom.ListItem

Эффект добавления EmbeddedObject объект DOM зависит от типа выходного документа и внешнего файла, как описано в этой таблице.

Тип выхода документа	Тип внешнего файла	Поведение
Word	`xlsx`, `pptx`, `docx`	Встраивает внешний файл в документ и вставляет ссылку OLE на внедренный файл. Если вы открываете документ, не открывая его предварительно с `rptview`Ссылка OLE отображает изображение местозаполнителя. После открытия документа с `rptview`ссылка OLE отображает изображение встроенного содержимого файла. Чтобы увидеть и отредактировать содержимое встроенного файла, дважды кликните изображение.
Word	Любой тип, кроме `xlsx`, `pptx`, или `docx`	Не встраивает файл в документ. Вставка гиперссылки во внешний файл.
PDF	Любой	Встраивает внешний файл в документ и вставляет аннотацию со значком скрепки. Чтобы открыть встроенный файл, дважды кликните значок. Чтобы увидеть значок скрепки, необходимо открыть PDF за пределами MATLAB^®. Если вы все еще не видите значок скрепки, попробуйте открыть PDF-файл с помощью другого средства просмотра PDF, такого как Adobe^® Акробат^®. Если необходимо открыть PDF с помощью средства просмотра, которое не отображает значок скрепки, вместо встраивания документа рассмотрите ссылку на документ при помощи `mlreportgen.dom.ExternalLink` объект.
HTML	Любой	Встраивает внешний файл в документ и вставляет гиперссылку во встроенный файл. В HTML гиперссылка работает только в том случае, если документ открывается вне MATLAB.
Однофайловый HTML	Любой	Не встраивает файл в документ. Вставка гиперссылки во внешний файл. Гиперссылка работает только, если вы открываете документ вне MATLAB.

The mlreportgen.dom.EmbeddedObject класс является handle класс.

Атрибуты класса

`ConstructOnLoad`	`true`
`HandleCompatible`	`true`

Для получения информации об атрибутах класса см. раздел «Атрибуты класса».

Создание

Описание

embObj = mlreportgen.dom.EmbeddedObject() создает пустой EmbeddedObject объект. Чтобы задать файл для встраивания, используйте свойство Target.

пример

embObj = mlreportgen.dom.EmbeddedObject(path) устанавливает свойство Target в путь к файлу для встраивания.

пример

embObj = mlreportgen.dom.EmbeddedObject(path,linkText) также задает текст ссылки. Текст ссылки применяется только, когда ссылка на файл является гиперссылкой. Этот конструктор создает mlreportgen.dom.Text объект для хранения текста ссылки.

embObj = mlreportgen.dom.EmbeddedObject(path,linkText,styleName) задает имя определяемого шаблоном стиля для текста ссылки. Этот конструктор создает mlreportgen.dom.Text объект, чтобы удерживать текст ссылки и устанавливать StyleName свойство Text объект к styleName.

embObj = mlreportgen.dom.EmbeddedObject(path,linkTextObj) использует mlreportgen.dom.Text объект, чтобы задать текст ссылки.

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

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

`path` - Путь к файлу для встраивания
вектор символов | строковый скаляр

Путь к файлу для встраивания, заданный как вектор символов или строковый скаляр.

`linkText` - Ссылка на текст
вектор символов | строковый скаляр

Ссылка на текст, заданная как вектор символов или строковый скаляр. Текст ссылки применяется только, когда ссылка на файл является гиперссылкой.

`linkTextObj` - Ссылка на текст
`mlreportgen.dom.Text` объект

Ссылка на текст, заданная как mlreportgen.dom.Text объект. Текст ссылки применяется только, когда ссылка на файл является гиперссылкой.

`styleName` - Имя стиля для текста ссылки
вектор символов | строковый скаляр

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

Свойства

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

`Target` - Путь к файлу для встраивания в документ
вектор символов | строковый скаляр

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

`StyleName` - Имя стиля, используемого для ссылки
вектор символов | строковый скаляр

Имя стиля для ссылки, заданное как вектор символов или строковый скаляр. Стиль, заданный как StyleName свойство должно быть определено в шаблоне, который используется для создания документа, которому EmbeddedObject добавляется. The StyleName свойство применяется только в том случае, если ссылка на файл является гиперссылкой.

`Style` - Форматы, определяющие стиль ссылки
массив ячеек объектов формата DOM

Форматы, определяющие стиль ссылки, заданные как массив ячеек объектов формата DOM. Форматы, заданные в Style форматы переопределения свойств, заданные определяемым шаблоном стилем. The Style свойство применяется только в том случае, если ссылка на файл является гиперссылкой.

`CustomAttributes` - Пользовательские атрибуты ссылки
`[]` | массивов ячеек `mlreportgen.dom.CustomAttribute` объекты

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

`Parent` - Родительский элемент элемента документа
Объект DOM

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

`Children` - Дочерние элементы элемента документа
массив объектов DOM

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

`Tag` - тег для этого элемента документа
вектор символов | строковый скаляр

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

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

`Id` - идентификатор для этого элемента документа
вектор символов | строковый скаляр

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

Методы

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

Общедоступные методы

append

Добавить текст, изображение или пользовательский элемент к ссылке на файл в документе. Использование append с mlreportgen.dom.EmbeddedObject объект так же, как вы используете append с mlreportgen.dom.ExternalLink объект.

The append метод применяется только в том случае, если ссылка на файл является гиперссылкой.

clone

clone = clone(embeddedObj) создает копию этого mlreportgen.dom.EmbeddedObject объект.

Чтобы повторить содержимое документа, используйте clone. Не добавляйте один и тот же объект к документу более одного раза.

Примеры

свернуть все

Встраивание документа Word в другой документ Word

Создайте документ Word, CompanyInfo.docx, и встройте его во второй документ Word, CompanyReport.docx.

import mlreportgen.dom.*

doc1 = Document('CompanyInfo','docx');
append(doc1, 'XYZ, Inc., makes widgets.');
close(doc1);

doc1Path = doc1.OutputPath;

doc2 = Document('CompanyReport','docx');
open(doc2);

para = append(doc2,Paragraph('About XYZ, Inc.'));
append(doc2, EmbeddedObject(doc1Path));
close(doc2);
rptview(doc2);

Документ, CompanyReport.docx, отображает изображение встроенного файла.

Document text, "About XYZ, Inc.", followed by a clickable image that reads XYZ, Inc., makes widgets.

Чтобы открыть встроенный документ, дважды кликните изображение.

Встраивание PDF в HTML

Создайте PDF, bio.pdfи встройте его в HTML, author.html. Задайте текст ссылки в mlreportgen.dom.EmbeddedObject конструктор. Сделайте ссылку зеленым.

import mlreportgen.dom.*
doc1 = Document('bio','pdf');
para = 'The author was born in New York, NY in 1970.';
append(doc1,para);
close(doc1);

doc2 = Document('author','html');
doc2.PackageType = 'unzipped';

embedObj = EmbeddedObject('bio.pdf','Author Biography');
embedObj.Style={Color('green')};
p = Paragraph();
append(p,embedObj);
append(doc2,p);

close(doc2);
rptview(doc2);

Документ author отображает ссылку на встроенный документ.

Чтобы открыть встроенный документ, откройте author/root.html за пределами MATLAB.

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

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

Внешний вид ссылки на встроенный файл в отчете PDF

Поведение изменено в R2020b

Начиная с R2020b, если вы используете mlreportgen.dom.EmbeddedObject для встраивания файла в отчет PDF, ссылка на внедренный файл вставляется в PDF как аннотация, которая имеет значок скрепки. Для примера:

Чтобы открыть встроенный файл, дважды кликните значок скрепки. В предыдущих релизах в PDF была вставлена гиперссылка на встроенный файл. Для примера:

См. также

mlreportgen.dom.ExternalLink | mlreportgen.dom.Text

Темы

Подходы к форматированию отчетов

Введенный в R2020a

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

mlreportgen.dom.EmbeddedObject class