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. Это свойство доступно только для чтения.

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

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

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

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

  • Блочное отверстие может содержать Paragraph, Table, OrderedList, UnorderedList, DocumentPart, или Group.

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

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

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

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

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

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

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

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

DOM генерирует тег с уникальным сеансом как часть создания этого объекта. Сгенерированный тег имеет форму 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

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

Примеры

свернуть все

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

Этот пример задает первые, четные и нечетные нижние колонтитулы страниц в 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

Поддержка

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