mlreportgen.dom. Заголовок класса

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

Уровень переменной использования абзаца заголовка

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

Описание

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

Совет

Используйте этот класс, если необходимо определить направляющийся уровень во времени выполнения. В противном случае можно использовать Heading1, Heading2, и т.д. классы, чтобы избежать необходимости устанавливать уровень явным образом.

Конструкция

headingObj = Heading(level) создает пустой заголовок на заданном уровне.

headingObj = Heading(level,text) создает заданный заголовок уровня, содержащий заданный текст.

headingObj = Heading(level,text,styleName) создает заданный заголовок уровня, содержащий заданный текст и использующий заданный стиль.

headingObj = Heading(level,domObj) создает заданный заголовок уровня, содержащий заданный Объект DOM.

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

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

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

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

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

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

Объект DOM, чтобы включать в заголовок, заданный как любой из этих типов Объекта DOM:

  • ExternalLink

  • Image

  • InternalLink

  • LinkTarget

  • Text

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

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

Абзац заголовка, представленный объектом mlreportgen.dom.Heading.

Свойства

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

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

  • Имя цвета. Имя должно быть названием цвета 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 является оттенком синего цвета.

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

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

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

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

  • cm — 'centimeters'

  • \in 'inches'

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

  • pc — цицеро

  • pt — 'points'

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

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

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

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

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

  • cm — 'centimeters'

  • \in 'inches'

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

  • pc — цицеро

  • pt — 'points'

  • px — 'pixels'

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

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

'center'

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

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

'distribute'

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

Word

'justify'

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

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

'KashidaHigh'

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

Word

'KashidaLow'

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

Word

'KashidaMedium'

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

Word

'left'

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

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

'right'

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

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

'ThaiDistribute'

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

Word

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

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

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

Оставленное добавление отступа в форме valueUnits. Units является сокращением от модулей. Допустимые сокращения:

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

  • cm — 'centimeters'

  • \in 'inches'

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

  • pc — цицеро

  • pt — 'points'

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

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

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

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

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

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

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

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

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

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

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

Уникальный идентификатор сеанса сгенерирован как часть создания элемента документа. Сгенерированный тег имеет форму 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 удаляет объект.

Чтобы задать, как обработать пробел, используйте одно из этих значений.

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

'normal' (значение по умолчанию)

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

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

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

'nowrap'

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

HTML

'preserve'

Пробелы консервов и переводы строки. Законы как <pre> помечают в HTML.

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

'pre'

Пробел консервов. Текст переносится только на разрывах строки. Законы как <pre> помечают в HTML.

HTML и PDF

'pre-line'

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

HTML и PDF

'pre-wrap'

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

HTML и PDF

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

Методы

Метод

Цель

append

Используйте Heading.append, подобный тому, как вы используете Paragraph.append.

Добавьте содержимое к заголовку.

clone

Используйте Heading.clone, подобный тому, как вы используете Paragraph.clone.

Скопируйте заголовок.

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

|

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