Exponenta Banner
exponenta event banner

mlreportgen.dom.Heading1 class

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

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

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

Описание

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

Конструкция

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

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

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

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

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

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

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

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

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

  • ExternalLink

  • Image

  • InternalLink

  • LinkTarget

  • Text

Свойства

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

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

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

Пример: 'blue'

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

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

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

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

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

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

Пример: 'blue'

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

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

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

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

  • cm 'centimeters'

  • in 'inches'

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

  • pc — цицеро

  • pt 'points'

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

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

Пример: '0.5in'

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

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

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

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

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

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

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

  • cm 'centimeters'

  • in 'inches'

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

  • pc — цицеро

  • pt 'points'

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DOM генерирует уникальный для сеанса тег как часть создания этого объекта. Сгенерированный тег имеет форму CLASS:ID, где КЛАСС является классом объекта, и 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 объект формата, который задает тип подчеркивания и цвет.

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

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

'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 свойство к пустому значению удаляет объект.

Методы

Метод

Цель

append

Используйте Heading1.append похожий на то, как вы используете Paragraph.append.

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

clone

Используйте Heading1.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

Поддержка