mlreportgen.dom.Text class

Пакет: mlreportgen.dom

Текстовый объект

Описание

Используйте объект mlreportgen.dom.Text класс, чтобы включать текст в документ.

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

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

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

Создание

Описание

textObj = mlreportgen.dom.Text() создает пустой Text объект.

пример

textObj = mlreportgen.dom.Text(text) создает Text объект, который содержит заданный текст и устанавливает Content свойство к text.

textObj = mlreportgen.dom.Text(text,styleName) также задает стиль и устанавливает StyleName свойство к styleName. Необходимо задать стиль в таблице стилей в шаблоне документа, к которому вы добавляете этот Text объект.

Свойства

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

`Content` — Текст содержится в этом элементе документа
вектор символов | строковый скаляр

Текст содержится в этом элементе документа в виде вектора символов.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Bold` — Использовать ли полужирный для текста
`[]` (значение по умолчанию) | `true` или `1` | `false` или `0`

Использовать ли полужирный для текста в виде числового или логического 1 TRUE) или 0 ложь). Сделать текст полужирным, набор Bold к true или 1.

Установка Bold свойство добавляет соответствующий mlreportgen.dom.Bold объект формата к Style свойство. Установка Bold свойство к пустому значению удаляет объект.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Italic` — Использовать ли курсив для текста
`[]` (значение по умолчанию) | `true` или `1` | `false` или `0`

Использовать ли курсив для текста в виде числового или логического 1 TRUE) или 0 ложь). Чтобы сделать текстовый курсив, установите Italic к true или 1.

Установка Italic свойство добавляет соответствующий mlreportgen.dom.Italic объект формата к Style свойство. Установка Italic свойство к пустому значению удаляет объект.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Color` TextColor
`[]` (значение по умолчанию) | вектор символов | строковый скаляр

Цвет текста в виде вектора символов или строкового скаляра, который состоит из названия цвета CSS (см. https://www.crockford.com/wrrrld/color.html), или шестнадцатеричный RGB (истинный цвет) значение в форме #RRGGBB.

Установка Color свойство добавляет соответствующий mlreportgen.dom.Color объект формата к Style свойство. Установка Color свойство к пустому значению удаляет объект.

Пример: 'blue'

Пример: "#0000ff"

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`

NonCopyable true

`BackgroundColor` BackgroundColor
`[]` (значение по умолчанию) | вектор символов | строковый скаляр

Цвет фона в виде вектора символов или строкового скаляра, который состоит из названия цвета CSS (см. https://www.crockford.com/wrrrld/color.html), или шестнадцатеричный RGB (истинный цвет) значение в форме #RRGGBB.

Установка BackgroundColor свойство добавляет соответствующий mlreportgen.dom.BackgroundColor объект формата к Style свойство. Установка BackgroundColor свойство к пустому значению удаляет объект.

Пример: 'blue'

Пример: "#0000ff"

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Underline` — Тип подчеркивания
`[]` (значение по умолчанию) | `"single"` | `"none"` | ...

Тип подчеркивания в виде одного из значений в этой таблице.

Подчеркните значение	Описание	Поддерживаемые выходные типы
`"single"`	Одна строка	Все
`"words"`	Подчеркните все символы кроме пробелов	Word
`"double"`	Двойная линия	Word
`"thick"`	Толстая линия	Word
`"dotted"`	Пунктирная линия	Word
`"dottedHeavy"`	Толстая пунктирная линия	Word
`"dash"`	Пунктирная линия	Word
`"dashedHeavy"`	Линия с тяжелыми тире	Word
`"dashLong"`	Линия с длинными тире	Word
`"dashLongHeavy"`	Линия с тяжелыми длинными тире	Word
`"dotDash"`	Точечный штриховой пунктир	Word
`"dashDotHeavy"`	Тяжелая штрихпунктирная линия	Word
`"dotDotDash"`	Точечный точечный штриховой пунктир	Word
`"dashDotDotHeavy"`	Линия с тяжелыми тире и двумя точками между тире	Word
`"wave"`	Волнистая линия	Word
`"wavyHeavy"`	Тяжелый волнистый	Word
`"wavyDouble"`	Удвойте волнистую линию	Word
`"none"`	Никакое подчеркивание	Все

Установка Underline свойство добавляет соответствующий mlreportgen.dom.Underline объект формата к Style свойство. Установка Underline свойство к пустому значению удаляет объект.

Чтобы задать и цвет и тип подчеркивания, не устанавливайте Underline свойство. Вместо этого установите Style свойство включать mlreportgen.dom.Underline объект формата, который задает тип подчеркивания и цвет.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`WhiteSpace` — Пробел и разрывы строки в тексте
`[]` (значение по умолчанию) | `"normal"` | `"nowrap"` | ...

Тип пробела и разрывов строки, чтобы использовать в тексте в виде одного из значений в таблице. WhiteSpace свойство не применяется когда Type свойство Document объектом является PDF.

Значение	Описание	Поддерживаемые выходные типы
`"normal"`	Не сохраняет пробел и разрывы строки.	Word и HTML
`"nowrap"`	Последовательности пробела выходят из строя в один пробел. Текст никогда не переносится к следующей строке.	HTML
`"preserve"`	Пробел консервов. Текст переносится когда необходимый и на разрывах строки. Законы как `<pre-wrap>` установка в HTML.	Word и HTML
`"pre"`	Пробел консервов. Текст переносится только на разрывах строки. Законы как `<pre>` установка в HTML.	HTML
`"pre-line"`	Последовательности пробела выходят из строя в один пробел. Текст переносится.	HTML
`"pre-wrap"`	Пробел консервов. Текст переносится когда необходимый и на разрывах строки	HTML

Если вы хотите просмотреть вывод HTML в MATLAB^® браузер и вы хотите сохранить пробел и свернуть текст только на разрывах строки, использовать preserve установка вместо pre установка.

Установка WhiteSpace свойство добавляет соответствующий WhiteSpace объект формата к Style свойство. Удаление WhiteSpace установка свойства удаляет WhiteSpace объект.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`FontFamilyName` — Имя семейства шрифтов для текста
`[]` | вектор символов | строковый скаляр

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

Установка FontFamilyName свойство добавляет соответствующий mlreportgen.dom.FontFamily объект формата к Style свойство. Установка FontFamilyName свойство совпадает с установкой FontName свойство mlreportgen.dom.FontFamily объект. Установка FontFamilyName свойство к пустому значению удаляет объект.

Чтобы задать замены на шрифт, не задавайте семейство шрифтов путем установки этого свойства. Вместо этого создайте и добавьте mlreportgen.dom.FontFamily возразите против Style свойство.

Пример: "Courier New"

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`FontSize` — Размер шрифта для текста
`[]` (значение по умолчанию) | вектор символов | строковый скаляр

Размер шрифта, чтобы использовать для текста в виде вектора символов или строкового скаляра, который состоит из номера, сопровождаемого сокращением от единицы измерения. Например, '12pt' задает двенадцать точек. Допустимые сокращения:

px — пиксели (значение по умолчанию)
cm 'centimeters'
in 'inches'
mm — миллиметры
pc — цицеро
pt 'points'

Установка FontSize свойство добавляет соответствующий mlreportgen.dom.FontSize объект формата к Style свойство. Установка FontSize свойство к пустому значению удаляет объект.

Пример: "12pt"

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Strike` — Текстовое перечеркивание
`[]` (значение по умолчанию) | `"none"` | `"single"` | `"double"`

Текстовое перечеркивание в виде одного из этих значений:

"none" — Никакое перечеркивание
"single" — Одна строка
"double" — Двойная линия (для Word сообщает только),

Установка Strike свойство добавляет соответствующий mlreportgen.dom.Strike объект формата к Style свойство для этого элемента документа. Установка Strike свойство к пустому значению удаляет объект.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`StyleName` — Разработайте для текста
вектор символов | строковый скаляр

Необходимо задать стиль в таблице стилей в шаблоне документа, к которому вы добавляете этот Text объект.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Style` Текстовое форматирование
массив ячеек объектов формата DOM

Текстовое форматирование в виде массива ячеек объектов формата DOM.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`CustomAttributes` — Пользовательские атрибуты элемента документа
массив `mlreportgen.dom.CustomAttribute` объекты

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

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

Родительский элемент этого объекта DOM API в виде объекта DOM API.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

`Children` — Дочерние элементы этого объекта DOM API
массив объектов ДОМА АПИ

Дочерние элементы этого объекта DOM API в виде массива объектов ДОМА АПИ.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

`Tag` — Пометьте для этого объекта DOM API
вектор символов | строковый скаляр

Пометьте для этого объекта DOM API в виде вектора символов или строкового скаляра.

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Id` — ID для этого объекта DOM API
вектор символов | строковый скаляр

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

Методы

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

Открытые методы

Метод	Цель
`append`	Добавьте пользовательский элемент к этому текстовому объекту. Используйте `append` метод для `Text` возразите таким же образом, что вы используете `append` метод для `Paragraph` объект.
`clone`	Скопируйте этот текстовый объект. Используйте `clone` метод для `Text` возразите таким же образом, что вы используете `clone` метод для `Paragraph` объект.

Примеры

свернуть все

Текст форматирования абзацев при помощи разных текстовых объектов

Скрипт Open Live Script

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

Импортируйте пакет API DOM так, чтобы вы не использовали долго, полностью определенные имена.

import mlreportgen.dom.*

Создайте Document объект.

d = Document("mydoc","html");

Создайте Paragraph объект.

para = Paragraph();

Создайте Text объект для текста, который вы хотите к полужирному и подчеркиванию. Добавьте Text возразите против объекта Paragraph,

paraTitle = Text("Results:");
paraTitle.Bold = true;
paraTitle.Underline = "single";
append(para,paraTitle);

Создайте Text объект для остальной части текста в абзаце и добавляет Text возразите против Paragraph объект.

paraContent = Text(" Study 1");
append(para,paraContent);
append(d,para);

Закройте и просмотрите отчет.

close(d);
rptview(d);

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

mlreportgen.dom.Text class

Описание

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

Создание

Описание

Свойства

Content — Текст содержится в этом элементе документа вектор символов | строковый скаляр

Атрибуты:

Bold — Использовать ли полужирный для текста [] (значение по умолчанию) | true или 1 | false или 0

Атрибуты:

Italic — Использовать ли курсив для текста [] (значение по умолчанию) | true или 1 | false или 0

Атрибуты:

Color TextColor [] (значение по умолчанию) | вектор символов | строковый скаляр

Атрибуты:

BackgroundColor BackgroundColor [] (значение по умолчанию) | вектор символов | строковый скаляр

Атрибуты:

Underline — Тип подчеркивания [] (значение по умолчанию) | "single" | "none" | ...

Атрибуты:

WhiteSpace — Пробел и разрывы строки в тексте [] (значение по умолчанию) | "normal" | "nowrap" | ...

Атрибуты:

FontFamilyName — Имя семейства шрифтов для текста [] | вектор символов | строковый скаляр

Атрибуты:

FontSize — Размер шрифта для текста [] (значение по умолчанию) | вектор символов | строковый скаляр

Атрибуты:

Strike — Текстовое перечеркивание [] (значение по умолчанию) | "none" | "single" | "double"

Атрибуты:

StyleName — Разработайте для текста вектор символов | строковый скаляр

Атрибуты:

Style Текстовое форматирование массив ячеек объектов формата DOM

Атрибуты:

CustomAttributes — Пользовательские атрибуты элемента документа массив mlreportgen.dom.CustomAttribute объекты

Атрибуты:

Parent — Родительский элемент этого объекта DOM API Объект DOM API

Атрибуты:

Children — Дочерние элементы этого объекта DOM API массив объектов ДОМА АПИ

Атрибуты:

Tag — Пометьте для этого объекта DOM API вектор символов | строковый скаляр

Атрибуты:

Id — ID для этого объекта DOM API вектор символов | строковый скаляр

Атрибуты:

Методы

Открытые методы

Примеры

Текст форматирования абзацев при помощи разных текстовых объектов

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

Темы

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

Поддержка

`Content` — Текст содержится в этом элементе документа
вектор символов | строковый скаляр

`Bold` — Использовать ли полужирный для текста
`[]` (значение по умолчанию) | `true` или `1` | `false` или `0`

`Italic` — Использовать ли курсив для текста
`[]` (значение по умолчанию) | `true` или `1` | `false` или `0`

`Color` TextColor
`[]` (значение по умолчанию) | вектор символов | строковый скаляр

`BackgroundColor` BackgroundColor
`[]` (значение по умолчанию) | вектор символов | строковый скаляр

`Underline` — Тип подчеркивания
`[]` (значение по умолчанию) | `"single"` | `"none"` | ...

`WhiteSpace` — Пробел и разрывы строки в тексте
`[]` (значение по умолчанию) | `"normal"` | `"nowrap"` | ...

`FontFamilyName` — Имя семейства шрифтов для текста
`[]` | вектор символов | строковый скаляр

`FontSize` — Размер шрифта для текста
`[]` (значение по умолчанию) | вектор символов | строковый скаляр

`Strike` — Текстовое перечеркивание
`[]` (значение по умолчанию) | `"none"` | `"single"` | `"double"`

`StyleName` — Разработайте для текста
вектор символов | строковый скаляр

`Style` Текстовое форматирование
массив ячеек объектов формата DOM

`CustomAttributes` — Пользовательские атрибуты элемента документа
массив `mlreportgen.dom.CustomAttribute` объекты

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

`Children` — Дочерние элементы этого объекта DOM API
массив объектов ДОМА АПИ

`Tag` — Пометьте для этого объекта DOM API
вектор символов | строковый скаляр

`Id` — ID для этого объекта DOM API
вектор символов | строковый скаляр