mlreportgen.dom.PDFPageFooter class

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

Определение нижнего колонтитула для документа в формате PDF

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

Описание

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

Конструкция

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

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

pdfFooter = PDFPageFooter(pageType,templatePath) создает нижний колонтитул на основе заданного шаблона.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Свойства

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

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

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

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

Тип текущего отверстия шаблона в виде 'Inline' или 'Block'.

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

  • Отверстие блока может содержать ParagraphТаблица, OrderedList, UnorderedList, DocumentPart, или Group.

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

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

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

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

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

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

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

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

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

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

Методы

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

Метод

Цель

append

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

  • CustomElement

  • FormalTable

  • Group

  • ExternalLink

  • Image

  • InternalLink

  • OrderedList

  • Paragraph

  • RawText

  • Table

  • Text

  • UnorderedList

close

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

fill

Заполните отверстие шаблона.

moveToNextHole

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

open

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

Примеры

свернуть все

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

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

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

% Create page footer objects for each type of page
% Assign a matrix of page footer objects to the current page layout
firstfooter = PDFPageFooter('first');
evenfooter = PDFPageFooter('even');
oddfooter = PDFPageFooter('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);

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

| | | |

Темы

Введенный в R2016a

Документация MATLAB Report Generator

Поддержка

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