Exponenta Banner
exponenta event banner

mlreportgen.dom.Предварительно отформатированный класс

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

Предварительно отформатированный блок текста

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

Описание

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

Если не установить FontFamilyName или Whitespace В свойствах DOM API используются значения по умолчанию для типа отчета (HTML, Microsoft ® Word или PDF), так что форматирование пробелов сохраняется. Можно переопределить значения по умолчанию, установив FontFamilyName или Whitespace свойства.

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

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

ConstructOnLoad
true
HandleCompatible
true

Сведения об атрибутах класса см. в разделе Атрибуты класса.

Создание

Описание

пример

preObj = mlreportgen.dom.Preformatted() создает пустой предварительно отформатированный абзац.

пример

preObj = mlreportgen.dom.Preformatted(text) создает предварительно отформатированный абзац, содержащий указанный текст.

preObj = mlreportgen.dom.Preformatted(text,styleName) создает предварительно отформатированный абзац с заданным стилем. Стиль, заданный styleName свойство должно быть определено в шаблоне, используемом для элемента документа, к которому присоединен этот абзац.

preObj = mlreportgen.dom.Preformatted(docElementObj) создает абзац, содержащий элемент документа, указанный docElementObj.

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

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

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

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

Элемент документа (объект DOM) для включения в этот абзац. Можно указать следующие объекты DOM:

Свойства

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

Уровень структуры абзаца, указанный как целое число. Установка OutlineLevel приводит к включению этого абзаца в автоматически создаваемые контуры, например в оглавление. Значение указывает уровень абзаца в контуре. Например, чтобы абзац отображался на верхнем уровне контура, установите OutlineLevel свойство для 1.

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

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

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

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

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

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

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

Пример: 'blue'

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

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

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

Пример: 'blue'

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

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

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

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

Обработка пробела в тексте, указанного как одно из значений в этой таблице.

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

'normal'

Для HTML и PDF это значение удаляет пробелы в начале и в конце текста. Несколько пробелов в тексте сворачиваются в одно пространство.

Для Word это значение удаляет пробелы в начале и конце текста.

Все

'nowrap'

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

HTML

'pre'

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

HTML и PDF

'pre-line'

Последовательности белого пространства сворачиваются в единое белое пространство. Текст переносится при необходимости и в строке разрывается.

HTML и PDF

'pre-wrap'

Сохраняет пробел. Текст переносится при необходимости и в строке разрывается.

HTML и PDF

'preserve'

То же, что и «pre».Все

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

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

Установка 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'

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

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

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

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

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

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

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

'center'

Центрировать абзац

Все

'distribute'

Распределить все символы поровну

Word

'justify'

Выравнивание левой части абзаца в левой части страницы или записи таблицы и правой части абзаца в правой части страницы или записи таблицы.

Все

'KashidaHigh'

Используйте самую широкую длину Кашиды.

Кашида - тип оправдания, используемый для некоторых курсивных письменностей, таких как арабский и персидский.

Word

'KashidaLow'

Использовать наименьшую длину Кашиды

Word

'KashidaMedium'

Использовать среднюю длину Кашиды

Word

'left'

Выровнять абзац по левому краю

Все

'right'

Выровнять абзац справа

Все

'ThaiDistribute'

Обоснование на тайском языке

Word

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

Размер отступа для первой строки этого абзаца, определяемый как вектор символов или строковый скаляр, состоящий из числа, за которым следует сокращение для единицы измерения. Например, «» 0.5in «» указывает на половину дюйма. Допустимые сокращения:

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

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

  • in - дюймы

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

  • pc - пикас

  • pt - точки

Размер отступа - это размер отступа первой строки этого абзаца относительно последующих строк. Для создания висячего отступа с отступом для всех строк, за исключением первой строки, используйте отрицательное число.

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

Пример: '0.5in'

Имя стиля для форматирования этого абзаца, заданного как вектор символа или скаляр строки.

Стиль, заданный StyleName свойство должно быть определено в таблице стилей документа или части документа, к которой присоединен этот абзац. Указанный стиль определяет внешний вид абзаца в выходном документе, за исключением форматов, заданных параметром Style свойство этого параграфа. Объекты формата, указанные Style форматы переопределения свойств, определенные в стиле.

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Открыть сценарий в реальном времени

Форматирование кода в отчете с помощью mlreportgen.dom.Preformatted объект. Пробелы и символы новой строки сохраняются в выходных данных. Шрифт кода - монопространство.

import mlreportgen.dom.*
import mlreportgen.report.*
rpt = Report('myReport','docx');

p = Paragraph("This is my code:");
pr = Preformatted("  a = 1;" + newline + "  b = 2;" + newline + "  c = a + b;");

add(rpt, p);
add(rpt,pr);

close(rpt);
rptview(rpt);

Вот код в созданном отчете:

См. также

| | | | | | | | | | | | |

Темы

Представлен в R2020a

Документация по генератору отчетов MATLAB

Поддержка