mlreportgen.dom.DOCXPageLayout class

Пакет: mlreportgen.dom

Формат страниц и размещение для раздела документа Microsoft Word

Описание

Используйте mlreportgen.dom.DOCXPageLayout объект задать формат страниц, заголовки и нижние колонтитулы раздела документа Word.

mlreportgen.dom.DOCXPageLayout классом является handle класс.

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

HandleCompatible
true
ConstructOnLoad
true

Для получения информации об атрибутах класса см. Атрибуты класса.

Создание

Описание

пример

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

Свойства

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

Верхние колонтитулы страницы для этого размещения в виде массива mlreportgen.dom.DOCXPageHeader объекты. Можно задать до трех верхних колонтитулов страницы для размещения, один каждый для:

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

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

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

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

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

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

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

Разметка XML для неподдерживаемых форматов размещения в виде массива ячеек из символьных векторов. Для получения информации о разметке XML для форматов Word см. https://www.ecma-international.org/publications/standards/Ecma-376.htm.

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

Размер страниц в этом размещении в виде mlreportgen.dom.PageSize объект.

Количество первой страницы в разделе в виде целого числа.

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

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

Опции разрыва раздела в виде одного из этих векторов символов или строковых скаляров:

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

  • 'Same Page' — Запустите раздел на той же странице как текущий раздел.

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

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

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

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

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

close(d);
rptview(d);

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

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

append(d,'This document has landscape pages');
close(d);
rptview(d);
Введенный в R2016a
Для просмотра документации необходимо авторизоваться на сайте