mlreportgen.dom. Класс PageBreakBefore

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

Запустите абзац на новой странице

Описание

Задает, чтобы всегда запустить связанный абзац на новой странице. Этот класс применяется к Microsoft® отчеты PDF и Word.

Конструкция

pageBreakBefore = PageBreakBefore() всегда запускает абзац на новой странице.

pageBreakBefore = PageBreakBefore(onOff) всегда запускает абзац на новой странице, если onOff является true.

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

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

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

  • true или 1 — Запускает абзац на новой странице.

  • false или 0 — Позволяет абзацу запускаться на текущей странице.

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

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

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

Разрыв страницы перед форматом, возвращенным как объект mlreportgen.dom.PageBreakBefore.

Свойства

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

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

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

Уникальный идентификатор сеанса сгенерирован как часть создания элемента документа. Сгенерированный тег имеет форму CLASS:ID, где CLASS является классом элемента, и ID является значением свойства Id объекта. Можно задать тег, чтобы заменить сгенерированный тег.

Например, чтобы облегчить идентифицировать, где проблема произошла во время генерации документов, можно задать собственное значение тега.

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

  • true или 1 — Запускает абзац на новой странице.

  • false или 0 — Позволяет абзацу запускаться на текущей странице.

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

Примеры

свернуть все

Этот пример показывает, как применить свойство PageBreakBefore к абзацу заголовка. Пример использует два подхода для применения свойств. Первое создает объект PageBreakBefore, значение которого явным образом верно. Можно затем присвоить тот объект формата свойству Style заголовка. Второй подход устанавливает свойство на направляющемся объекте, явным образом не создавая объект PageBreakBefore.

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

% Create first page text
t = Heading(1,'Document Title','Title');
h = Heading(2,'My Head','Heading1');
p = Paragraph('Hello World');

append(d,t);
append(d,h);
append(d,p);

% Create a heading paragraph h1
% Create a PageBreakBefore object and set it as a Style property on h1
h1 = Heading(2,'My Second Head','Heading1');
br = {PageBreakBefore(true)};
h1.Style = br;
p1 = Paragraph('Another page');

% Create a heading paragraph h2
% Set the h2 Style property to use PageBreakBefore set to true
h2 = Heading(2,'My Third Head','Heading1');
h2.Style = {PageBreakBefore()};
p2 = Paragraph('My third page');

append(d,h1);
append(d,p1);
append(d,h2);
append(d,p2);

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