mlreportgen.dom.PageBreakBefore class

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

Начните абзац на новой странице

Описание

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

Конструкция

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

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

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

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

Опция запуска абзаца на новой странице, заданная как одно из следующих значений:

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

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

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

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

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

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

Свойства

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

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

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

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

Опция запуска абзаца на новой странице, заданная как одно из следующих значений:

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

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

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

Примеры

свернуть все

В этом примере показано, как применить PageBreakBefore свойство к заголовку абзаца. В примере используются два подхода к применению свойств. Первый создает PageBreakBefore объект, значение которого явным образом соответствует true. Затем можно назначить этот объект формата заголовку 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);