exponenta event banner

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 (truecolor) в форме #RRGGBB.

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

Пример: 'blue'

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

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

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

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

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

Пример: 'blue'

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

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

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

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

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

  • in - дюймы

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

  • pc - пикас

  • pt - точки

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

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

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

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

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

  • in - дюймы

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

  • pc - пикас

  • pt - точки

  • px - пикселы

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

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

'center'

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

Все

'distribute'

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

Word

'justify'

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

Все

'KashidaHigh'

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

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

Word

'KashidaLow'

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

Word

'KashidaMedium'

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

Word

'left'

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

Все

'right'

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

Все

'ThaiDistribute'

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

Word

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

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

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

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

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

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

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

  • in - дюймы

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

  • pc - пикас

  • pt - точки

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Методы

Метод

Цель

append

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

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

clone

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

Копировать заголовок.