mlreportgen.dom.PDFPageLayout class

Пакет: mlreportgen.dom

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

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

Описание

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

The 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 генерирует уникальный идентификатор сеанса при создании элемента документа. Вы можете задать свой собственный идентификатор.

Методы

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

Примеры

свернуть все

Открыть Live Script

Используйте 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);
Открыть Live Script

По умолчанию 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

MATLAB Report Generator

Поддержка

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