exponenta event banner

класс mlreportgen.dom.PDFPageLayout

Пакет: mlreportgen.dom

Формат и макет страницы для раздела документа PDF

Описание

Использовать mlreportgen.dom.PDFPageLayout для определения формата страницы, колонтитулов и колонтитулов раздела PDF-документа.

mlreportgen.dom.PDFPageLayout класс является handle класс.

Атрибуты класса

HandleCompatible
true
ConstructOnLoad
true

Сведения об атрибутах класса см. в разделе Атрибуты класса.

Создание

Описание

пример

pageLayoutObj = mlreportgen.dom.PDFPageLayout() создает PDFPageLayout со значениями свойств по умолчанию.

Свойства

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

Заголовки страниц для этого макета, указанные как массив mlreportgen.dom.PDFPageHeader объекты. Для макета можно определить до трех заголовков страниц, по одному для:

  • Первая страница раздела

  • Четные страницы

  • Нечетные страницы

Нижний колонтитул страницы для этого макета, указанный как массив mlreportgen.dom.PDFPageFooter объекты. Для макета можно определить до трех нижних колонтитулов страниц, по одному для:

  • Первая страница раздела

  • Четные страницы

  • Нечетные страницы

Водяной знак для применения к этому разделу, указанный как mlreportgen.dom.Watermark объект.

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

  • true - Включает расстановку переносов и использует '-' для символа расстановки переносов.

  • '-' - Включает расстановку переносов и использует '-' для символа расстановки переносов.

  • ' ' - Включает расстановку переносов и использует пробел (' ') для символа расстановки переносов

  • false - Отключает расстановку переносов.

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

Размер страниц в этом макете, указанный как mlreportgen.dom.PageSize объект.

Номер первой страницы в разделе, указанный как целое число.

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

СтоимостьЗначениеПрименяется к
DOCXPDF
'a'Строчная буква
'A'Буква в верхнем регистре
'i'Строчные римские цифры
'I'Прописные римские цифры
'n', 'N', '1', 'decimal'Арабские цифры
'numberInDash'Число с тире с обеих сторон 
'hebrew1'Еврейские цифры 
'hebrew2'Еврейский алфавит 
'arabicAlpha'Арабский алфавит 
'arabicAbjad'Арабские абджадские цифры 
'thaiLetters'Тайские письма 
'thaiNumbers'Тайские цифры  
'thaiCounting'Тайская система счёта 

Параметры разрыва раздела, указанные как один из следующих векторов символов или строковых скаляров:

  • 'Next Page'- Запустите раздел на следующей странице.

  • 'Odd Page'- Запустите раздел на нечетной странице.

  • 'Even Page'- Запустите раздел на четной странице.

Это свойство не применяется к макетам страниц.

Форматы, применяемые к этому макету, заданному как массив объектов формата. Форматы, которые не применяются к макету страницы, игнорируются.

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Используйте CurrentPageLayout свойство документа для доступа к PDFPageLayout объект, представляющий макет документа. Измените левое и правое поля листа, установив Left и Right свойства mlreportgen.dom.PageMargins объект, используемый PDFPageLayout объект.

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

open(d);
pageLayoutObj = d.CurrentPageLayout;
pageLayoutObj.PageMargins.Left = '2in';
pageLayoutObj.PageMargins.Right = '2in';
p = Paragraph('Hello World');
append(d,p);

close(d);
rptview(d);

По умолчанию a PDFPageLayout объект определяет страницу с высотой 11 дюймов, шириной 8,5 дюйма и портретной ориентацией. Чтобы изменить ориентацию на альбомную, используйте rotate способ PDFPageLayout объект. Метод обновляет значения свойств связанного mlreportgen.dom.PageSize объект так, что высота составляет 8,5 дюйма, ширина - 11 дюймов, а ориентация - ландшафтная.

import mlreportgen.dom.*;
d = Document('myreport','pdf');
open(d);
 
pageLayoutObj = d.CurrentPageLayout;
rotate(pageLayoutObj);

append(d,'This document has landscape pages');
close(d);
rptview(d);
Представлен в R2016a