Exponenta Banner
exponenta event banner

mlreportgen.dom.Preformatted class

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

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

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

Описание

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

Если вы не устанавливаете FontFamilyName или Whitespace свойства, ДОМ АПИ использует значения по умолчанию для типа отчета (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 ложь). Сделать текст полужирным, набор Bold к true или 1.

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

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

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

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

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

Пример: 'blue'

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

Цвет фона в виде вектора символов или строкового скаляра, который состоит из названия цвета CSS (см. https://www.crockford.com/wrrrld/color.html), или шестнадцатеричный RGB (истинный цвет) значение в форме #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'

То же самое как 'пред'.Все

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

  • in 'inches'

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

  • pc — цицеро

  • pt 'points'

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

Пример: '12pt'

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

  • 'none' — Никакое перечеркивание

  • 'single' — Одна строка

  • 'double' — Двойная линия (для Word сообщает только),

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

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

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

'center'

Сосредоточьте абзац

Все

'distribute'

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

Word

'justify'

Выровняйте сторону по левому краю абзаца на левой стороне страницы или записи таблицы и правой стороны абзаца на правой стороне страницы или записи таблицы.

Все

'KashidaHigh'

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

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

Word

'KashidaLow'

Используйте самую низкую длину Kashida

Word

'KashidaMedium'

Используйте среднюю длину Kashida

Word

'left'

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

Все

'right'

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

Все

'ThaiDistribute'

Тайское выравнивание языка

Word

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

Объем добавления отступа для линии кулака этого абзаца в виде вектора символов или строкового скаляра, который состоит из номера, сопровождаемого сокращением от единицы измерения. Например, '0.5 дюйма' задает половину дюйма. Допустимые сокращения:

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

  • cm 'centimeters'

  • in 'inches'

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

  • pc — цицеро

  • pt 'points'

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

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

Пример: '0.5in'

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Скрипт Open Live Script

Код формата в отчете при помощи 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 Report Generator

Поддержка