mlreportgen.dom. Класс Heading5

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

Создайте абзац Heading5

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

Описание

Создайте объект абзаца mlreportgen.dom.Heading5.

Конструкция

headingObj = Heading5() создает пустой объект Heading5.

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

headingObj = Heading5(text,styleName) создает заголовок с помощью заданного стиля.

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

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

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

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

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

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

  • ExternalLink

  • Image

  • InternalLink

  • LinkTarget

  • 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.CustomAttribute. Используйте пользовательские атрибуты, поддержанные выходным форматом.

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

Задайте значение в форме 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 удаляет объект.

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

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

Пробел между левой внешней границей этого абзаца и левой внутренней границей его контейнера. Это эквивалентно левому свойству добавления отступа абзаца Word Microsoft®.

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

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

Значение имеет форму 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 удаляет объект.

Объекты формата, которые задают формат элемента документа.

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

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

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

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

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

clone

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

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

Примеры

свернуть все

Открыть скрипт

Этот пример показывает, как добавить три уровня заголовков, каждый отформатированный согласно его уровню. Этот пример вставляет три направляющихся объекта в документ: Heading1, Heading2 и Heading3.

import mlreportgen.dom.*;
d = Document('mydoc','docx');
open(d);

title = append(d, Paragraph('Document Title'));
title.Bold = true;
title.FontSize = '28pt';

h1 = append(d,Heading1('Chapter 1'));
h1.Style = {PageBreakBefore(true)};
p1 = append(d,Paragraph('Hello World'));

h2 = append(d,Heading2('Section 1.1'));
p2 = append(d,Paragraph('Text for this section.'));

h3 = append(d,Heading3('My Subsection 1.1.a'));
p3 = append(d,Paragraph('Text for this subsection'));

close(d);
rptview(d.OutputPath);

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

| | | | | |

Темы

Введенный в R2016a

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