Exponenta Banner

mlreportgen.dom. Класс PageNumber

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

Номера страниц формата

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

Описание

Задает начальное значение номера страницы, одним словом, макет страницы и тип номера, такого как римские цифры. Установите это свойство как стиль на DOCXPageLayout или объекте PDFPageLayout. Вставьте номер страницы в объект макета страницы использование mlreportgen.dom.Page, чтобы видеть эффект этого формата.

Этот объект позволяет вам создать составные номера страниц в форме [Глава #]– [Page#] и задать разделитель. Для примера смотрите, Добавляют Комплексные Номера страниц в Microsoft Word.

Конструкция

pgnum = PageNumber() задает числовой номер страницы, значение которого продолжается от предыдущей страницы.

pgnum = PageNumber(number) устанавливает начальное значение к конкретному количеству.

pgnum = PageNumber(number,format) использует заданный тип номера, такого как римские цифры.

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

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

Количество первой страницы в этом размещении, заданном как положительное целое число.

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

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

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

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

Формат номера страницы, возвращенный как объект mlreportgen.dom.PageNumber.

Свойства

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

Символ, чтобы использовать, чтобы разделить номер главы от номера страницы, заданного как одно из этих значений:

  • 'colon' или ';' — Двоеточие.

  • 'hyphen' или '-' — Дефис.

  • 'emdash' — Длинное тире (—).

  • 'endash' — Короткое тире (–).

  • 'period' или '.' — Период.

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

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

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

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

Значение первого номера страницы в этом размещении, заданном как положительное целое число.

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

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

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

Примеры

свернуть все

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

Этот пример показывает синтаксис для использования PageNumber, который вы устанавливаете использование PageNumber как стиль на текущем макете страницы. Для нумерации, чтобы вступить в силу, необходимо вставить номер страницы в нижний колонтитул или заголовок с помощью Page, и необходимо использовать многоуровневый стиль списка в шаблоне Word. Для полного примера смотрите, Добавляют Комплексные Номера страниц в Microsoft Word

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

open(d);
layout = d.CurrentPageLayout;

% Start on page 7 and use roman numerals
pagenumber = PageNumber(7,'I');

% Add page number object to page layout styles
layout.Style = [layout.Style {pagenumber}];

% Create the footer and add a page number to it
myfooter = DOCXPageFooter();
para = Paragraph();
para.HAlign = 'center';
append(para,Page());

% Add the page number to the footer
append(myfooter,para);
layout.PageFooters = myfooter;

% Add content
append(d,'Hello World')';

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

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

| | | |

Темы

Документация MATLAB Report Generator
Поддержка