exponenta event banner

mlreportgen.dom.Текстовый класс

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

Описание

Текст для включения в элемент документа

Строительство

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

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

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

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

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

Массив символов, содержащих текст

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

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

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

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

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

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

Свойства

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

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

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

Пример: 'blue'

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

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

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

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

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

Пример: 'blue'

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

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

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

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

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

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

Пример: 'Courier New'

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

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

  • cm - сантиметров

  • in - дюймы

  • mm - миллиметров

  • pc - пикас

  • pt - точки

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

Пример: '12pt'

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

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

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

Зачеркивание текста, указанное как одно из следующих значений:

  • 'none' - Без зачеркивания

  • 'single' - Одиночная линия

  • 'double' - Двойная строка (только для отчетов Word)

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

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

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

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

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

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

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

'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 форматировать объект, определяющий тип подчеркивания и цвет.

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

СтоимостьОписаниеПоддерживаемые типы вывода

'normal'

Не сохраняет пробелы и разрывы строк

Слово и HTML

'nowrap'

Последовательности белого пространства сворачиваются в единое белое пространство. Текст никогда не переносится в следующую строку.

HTML

'preserve'

Сохраняет пробел. Текст переносится при необходимости и в строке разрывается. Действует как <pre-wrap> в HTML.

Слово и 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

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