mlreportgen.dom. Класс DOCXPageFooter

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

Определение нижнего колонтитула для документа Microsoft Word

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

Описание

Добавьте нижний колонтитул в первую страницу макета документа Word или к нечетным страницам, четным страницам или обоим.

Конструкция

docxFooter = DOCXPageFooter() создает нижний колонтитул на основе шаблона Word по умолчанию.

docxFooter = DOCXPageFooter(pageType) создает нижний колонтитул для заданного типа страницы, то есть, нечетный, даже, или сначала, на основе шаблона Word по умолчанию.

docxFooter = DOCXPageFooter(pageType,templatePath) создает нижний колонтитул для заданного типа страницы на основе заданного шаблона.

docxFooter = DOCXPageFooter(pageType,templatePath,docPartTemplateName) создает нижний колонтитул для заданного типа страницы, на основе заданного шаблона части документа в заданном шаблоне.

docxFooter = DOCXPageFooter(pageType,templateSrc,docPartTemplateName) создает нижний колонтитул для заданного типа страницы, на основе заданного шаблона части документа из заданного источника. Источник может быть документом или частью документа.

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

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

Тип страниц нижний колонтитул кажется на, заданным как одно из этих значений:

  • default — Нижний колонтитул для нечетных страниц раздела, четные страницы, если вы не задаете нижний колонтитул четной страницы и первую страницу, если вы не задаете первый нижний колонтитул.

  • first — Нижний колонтитул для первой страницы раздела.

  • even — Нижний колонтитул для четных страниц раздела.

Например, чтобы заставить различные нижние колонтитулы появиться на нечетных страницах и на четных страницах, задайте два нижних колонтитула. Установите pageType на default для одного и на even для другого.

Полный путь шаблона нижнего колонтитула, заданного как вектор символов.

Имя шаблона этой части, если это хранится в шаблоне, заданном аргументом templatePath или templateSrc, заданным как вектор символов.

Документ или часть документа возражают, чей шаблон содержит шаблон для этой части документа, заданной как объект mlreportgen.dom.Document для документа или объект mlreportgen.dom.DocumentPart для части документа.

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

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

Нижний колонтитул для документа Word, возвращенного как объект mlreportgen.dom.DOCXPageFooter.

Свойства

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

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

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

Это свойство только для чтения является ID дыры текущей дыры в этом документе.

Тип текущей дыры шаблона, заданной как 'Inline' или 'Block'.

  • Встроенная дыра для элементов документа, которые может содержать элемент абзаца: Text, Image, LinkTarget, ExternalLink, InternalLink, CharEntity, AutoNumber.

  • Дыра блока может содержать Paragraph, Table, OrderedList, UnorderedList, DocumentPart или Group.

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

Тип страницы, на которой нижний колонтитул кажется, заданным как одно из этих значений:

  • default — Нижний колонтитул для нечетных страниц раздела, четные страницы, если вы не задаете нижний колонтитул четной страницы и первую страницу, если вы не задаете первый нижний колонтитул.

  • first — Нижний колонтитул для первой страницы раздела.

  • even — Нижний колонтитул для четных страниц в разделе.

Чтобы иметь нижний колонтитул появляются на нечетных страницах и на четных страницах, задают два нижних колонтитула, один с набором pageType к default и другому с набором pageType к even.

Это списки свойств только для чтения родительский элемент этого элемента документа.

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

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

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

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

Методы

Используйте методы DocumentPageFooter, как вы используете соответствующие методы Document.

Метод

Цель

append

Добавьте один из этих Объектов DOM к нижнему колонтитулу:

  • CustomElement

  • FormalTable

  • Group

  • ExternalLink

  • Image

  • InternalLink

  • OrderedList

  • Paragraph

  • RawText

  • Table

  • Text

  • UnorderedList

close

Закройте нижний колонтитул.

fill

Заполните дыру шаблона.

moveToNextHole

Переместитесь в следующую дыру шаблона.

open

Откройте нижний колонтитул.

Примеры

свернуть все

Открыть скрипт

Этот пример задает сначала, даже, и нечетные нижние колонтитулы, одним словом, документ. Это вставляет номер страницы в каждый нижний колонтитул, с помощью различного выравнивания для каждого типа страницы.

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

% Create page footer objects for each type of page
% Assign a matrix of page footer objects to the current page layout
firstfooter = DOCXPageFooter('first');
evenfooter = DOCXPageFooter('even');
oddfooter = DOCXPageFooter('default');
d.CurrentPageLayout.PageFooters = [firstfooter,evenfooter,oddfooter];

% Add title to first page footer
p = Paragraph('My Document Title');
p.HAlign = 'center';
append(d.CurrentPageLayout.PageFooters(1),p);

% Add page number to even page footer
% Align even page numbers left
pg2 = Page();
p2 = Paragraph();
p2.HAlign = 'left';
append(p2,pg2);
append(d.CurrentPageLayout.PageFooters(2),p2);

% Add page number to odd page footer
% Align odd page numbers right
pg3 = Page();
p3 = Paragraph();
p3.HAlign = 'right';
append(p3,pg3);
append(d.CurrentPageLayout.PageFooters(3),p3);

% Create several pages.
p = Paragraph('Hello World');
append(d,p);
p = Paragraph('Another page');
p.Style = {PageBreakBefore(true)};
append(d,p);
append(d,clone(p));

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

Смотрите также

| | | |

Темы

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