mlreportgen.dom.Text class

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

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

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

Описание

Текст, чтобы включать в элемент документа

Конструкция

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

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

textObj = Text(text,styleName) создает текстовый объект, содержащий заданный текст с помощью заданного стиля. Стиль должен быть задан в таблице стилей шаблона документа, к которому добавлен этот текстовый объект.

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

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

Массив char, содержащего текст

Типы данных: char

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

Типы данных: char

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

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

Текст, возвращенный как mlreportgen.dom.Text объект.

Свойства

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

Цвет фона, заданный как также:

  • Имя цвета. Имя должно быть названием цвета CSS. См. https://www.crockford.com/wrrrld/color.html.

  • Шестнадцатеричный RGB (истинный цвет) значение как #RRGGBB. Например, #0000ff оттенок синего цвета.

Чтобы сделать текст полужирным, установите это свойство на true или 1. Если это свойство пусто и StyleName свойство для этого элемента документа задает стиль таблицы стилей, вес текста определяется тем стилем. Установка Bold свойство добавляет соответствующий mlreportgen.dom.Bold объект формата к Style свойство этого элемента документа. Удаление Bold установка свойства удаляет объект.

Типы данных: логический

Цвет текста, заданный как также:

  • Имя цвета. Имя должно быть названием цвета CSS. См. https://www.crockford.com/wrrrld/color.html.

  • Шестнадцатеричный RGB (истинный цвет) значение как #RRGGBB. Например, #0000ff оттенок синего цвета.

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

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

Имя семейства шрифтов.

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

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

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

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

Размер шрифта для текста, в форме valueUnits, где Units сокращение от модулей. Используйте одно из этих сокращений от модулей:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

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

Чтобы использовать курсив в тексте, установите это свойство на true. Если это свойство пусто и StyleName свойство для этого элемента документа задает стиль таблицы стилей, наклон текста определяется тем стилем. Установка Italic свойство добавляет соответствующий mlreportgen.dom.Italic объект формата к Style свойство этого элемента документа. Удаление Italic установка свойства удаляет объект.

Типы данных: логический

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

  • 'none' — Не используйте перечеркивание.

  • 'single' — Используйте одну строку в перечеркивании.

  • 'double' — Используйте двойную линию в перечеркивании для документов Word.

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

Массив ячеек объектов формата DOM, который задает формат для текста.

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

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

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

Можно задать один из следующих типов подчеркиваний.

Ограничьте значениеОписаниеПоддерживаемые Выходные типы

'dash'

Пунктирное подчеркивание

Word

'dashedHeavy'

Линия с тяжелыми тире

Word

'dashLong'

Линия с длинными тире

Word

'dashLongHeavy'

Линия с тяжелыми длинными тире

Word

'dashDotDotHeavy'

Линия с тяжелыми тире с двумя точками между тире

Word

'dashDotHeavy'

Тяжелая штрихпунктирная линия

Word

'dotted'

Пунктирная линия

Word

'dottedHeavy'

Толстая пунктирная линия

Word

'dotDash'

Точечный штриховой пунктир

Word

'dotDotDash'

Точечный точечный штриховой пунктир

Word

'dashDotHeavy'

Тяжелый точечный штриховой пунктир

Word

'double'

Двойная линия

Word

'none'

Не используйте подчеркивание

Все выходные типы

'single'

Одна строка

Все выходные типы

'thick'

Толстая линия

Word

'wave'

Волнистая линия

Word

'waveyDouble'

Удвойте волнистую линию

Word

'waveyHeavy'

Тяжелый волнистый

Word

'words'

Подчеркните непробелы только

Word

Если это свойство пусто и StyleName свойство этого элемента документа задает стиль таблицы стилей, тип подчеркивания определяется тем стилем.

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

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

Чтобы задать, как обработать пробел, используйте одно из этих значений. WhiteSpace свойство не применяется к формату PDF за Text объекты.

ЗначениеОписаниеПоддерживаемые Выходные типы

'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 объект.

Методы

Используйте Text.append и Text.clone методы тем же путем вы используете Paragraph.append и Paragraph.clone методы.

Метод

Цель

append

Добавьте пользовательский элемент к этому текстовому объекту.

clone

Клонируйте этот текстовый объект

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

| |

Темы

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