Exponenta Banner
exponenta event banner

класс mlreportgen.dom.PDFPageFooter

Пакет: 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

Поддержка