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 зависит от документа выходной тип и внешний тип файла, как описано в этой таблице.

Документ Выходной типВнешний тип файлаПоведение
Wordxlsx, pptx, docx

Встраивает внешний файл в документ и вставляет Связывание объектов и Встраивание (OLE) ссылка на встроенный файл.

Если вы открываете документ, не открывая сначала его с rptview, ссылка OLE отображает изображение заполнителя. После того, как вы открываете документ с rptview, ссылка OLE отображает изображение встроенного содержимого файла. Чтобы видеть и отредактировать встроенное содержимое файла, дважды кликните изображение.

WordЛюбой тип кроме xlsx, pptx, или docx

Не встраивает файл в документ. Вставляет гиперссылку на внешний файл.

PDF, HTMLЛюбой

Встраивает внешний файл в документ и вставляет гиперссылку на встроенный файл.

В документе HTML работает гиперссылка, только если вы открываете документ за пределами MATLAB®.

В документе в формате PDF работает гиперссылка, только если вы открываете документ с помощью средства просмотра PDF, такого как Adobe® Acrobat®, который поддерживает встроенные файлы. Если необходимо открыть документ в формате PDF со средством просмотра, которое не поддерживает встроенные файлы, вместо того, чтобы встроить документ, рассматривает соединение с документом при помощи mlreportgen.dom.ExternalLink объект.

Однофайловый HTMLЛюбой

Не встраивает файл в документ. Вставляет гиперссылку на внешний файл.

Гиперссылка работает, только если вы открываете документ за пределами MATLAB.

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

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

ConstructOnLoad
true
HandleCompatible
true

Для получения информации об атрибутах класса см. Атрибуты класса (MATLAB).

Создание

Описание

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,linkTextObj) использует mlreportgen.dom.Text объект задать текст ссылки.

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

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

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

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

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

Свойства

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

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Создайте документ 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, 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 отображает ссылку на встроенный документ.

The link text is "Author Biography". The link and text are green.

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

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

|

Темы

Введенный в R2020a

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