mlreportgen.dom.DOCXPageHeader class

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

Определение заголовка страницы для документа Microsoft Word

Описание

Добавить заголовок на первую страницу раздела или на нечетные страницы, четные страницы или и то, и другое.

Конструкция

docxHeader = DOCXPageHeader() создает заголовок страницы на основе шаблона Word по умолчанию.

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

docxHeader = DOCXPageHeader(pageType,templatePath) создает заголовок страницы для заданного типа страницы на основе заданного шаблона.

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

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

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

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

`pageType` - Тип заголовка страниц появляется на
`[]` (по умолчанию) | `default` | `first` | `even`

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

default - Заголовок для нечетных страниц раздела, четные страницы, если вы не задаете заголовок четной страницы, и первая страница, если вы не задаете заголовок первой страницы.
first - Заголовок для первой страницы раздела.
even - Заголовок для четных страниц в разделе.

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

`templatePath` - Полный путь к шаблону заголовка
вектор символов

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

`docPartTemplateName` - Имя шаблона детали документа
вектор символов

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

`templateSrc` - деталь документа или документа, содержащая шаблон детали документа;
`mlreportgen.dom.Document` | объекта `mlreportgen.dom.DocumentPart` объект

Объект детали документа или документа, шаблон которого содержит шаблон для этой детали документа, заданный как mlreportgen.dom.Document объект для документа или mlreportgen.dom.DocumentPart объект для детали документа.

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

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

`docxHeader` - Заголовок страницы для документа Word
`mlreportgen.dom.DOCXPageHeader` объект

Заголовок страницы для документа Word, возвращенный как mlreportgen.dom.DOCXPageHeader объект.

Свойства

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

`Children` - Дочерние элементы элемента документа
массив объектов DOM

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

`CurrentHoleId` - идентификатор текущего отверстия в документе
вектор символов

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

`CurrentHoleType` - Тип текущего отверстия
`'Inline'` | `'Block'`

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

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

`CurrentPageLayout` - Текущий макет страницы этого документа
`mlreportgen.dom.DOCXPageLayout` | объекта `mlreportgen.dom.PDFPageLayout` объект

Это свойство относится к документам Word и PDF. Для документов Word значение является DOCXPageLayout объект, задающий текущий макет страницы. Для PDF значение является PDFPageLayout Объект, задает ли документ в данный момент макет страницы. Для документов HTML значение всегда является [].

`Id` - идентификатор для этого элемента документа
вектор символов | строковый скаляр

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

`PageType` - Тип заголовка страниц появляется на
`[]` (по умолчанию) | `default` | `first` | `even`

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

default - Заголовок для нечетных страниц раздела, четные страницы, если вы не задаете заголовок четной страницы, и первая страница, если вы не задаете заголовок первой страницы.
first - Заголовок для первой страницы раздела.
even - Заголовок для четных страниц в разделе.

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

`Parent` - Родительский элемент элемента документа
Объект DOM

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

`Tag` - тег для этого элемента документа
вектор символов | строковый скаляр

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

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

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

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

Методы

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

Метод	Цель
`append`	Добавьте один из следующих объектов DOM к заголовку: `CustomElement` `DOCXPageLayout` `FormalTable` `Group` `ExternalLink` `Image` `InternalLink` `OrderedList` `Paragraph` `RawText` `Table` `Text` `UnorderedList`
`close`	Закройте заголовок.
`fill`	Заливка отверстия шаблона.
`moveToNextHole`	Перейдите к следующему отверстию шаблона.
`open`	Откройте заголовок.

См. также

mlreportgen.dom.DOCXPageFooter | mlreportgen.dom.DOCXPageLayout | mlreportgen.dom.PDFPageFooter | mlreportgen.dom.PDFPageHeader | mlreportgen.dom.PDFPageLayout

Темы

Создание нижних колонтитулов и колонтитулов

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

mlreportgen.dom.DOCXPageHeader class

Описание

Конструкция

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

`pageType` - Тип заголовка страниц появляется на
`[]` (по умолчанию) | `default` | `first` | `even`

`templatePath` - Полный путь к шаблону заголовка
вектор символов

`docPartTemplateName` - Имя шаблона детали документа
вектор символов

`templateSrc` - деталь документа или документа, содержащая шаблон детали документа;
`mlreportgen.dom.Document` | объекта `mlreportgen.dom.DocumentPart` объект

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

`docxHeader` - Заголовок страницы для документа Word
`mlreportgen.dom.DOCXPageHeader` объект

Свойства

`Children` - Дочерние элементы элемента документа
массив объектов DOM

`CurrentHoleId` - идентификатор текущего отверстия в документе
вектор символов

`CurrentHoleType` - Тип текущего отверстия
`'Inline'` | `'Block'`

`CurrentPageLayout` - Текущий макет страницы этого документа
`mlreportgen.dom.DOCXPageLayout` | объекта `mlreportgen.dom.PDFPageLayout` объект

`Id` - идентификатор для этого элемента документа
вектор символов | строковый скаляр

`PageType` - Тип заголовка страниц появляется на
`[]` (по умолчанию) | `default` | `first` | `even`

`Parent` - Родительский элемент элемента документа
Объект DOM

`Tag` - тег для этого элемента документа
вектор символов | строковый скаляр

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

Методы

См. также

Темы

MATLAB Report Generator

Поддержка

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

mlreportgen.dom.DOCXPageHeader class

Описание

Конструкция

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

pageType - Тип заголовка страниц появляется на [] (по умолчанию) | default | first | even

templatePath - Полный путь к шаблону заголовка вектор символов

docPartTemplateName - Имя шаблона детали документа вектор символов

templateSrc - деталь документа или документа, содержащая шаблон детали документа; mlreportgen.dom.Document | объекта mlreportgen.dom.DocumentPart объект

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

docxHeader - Заголовок страницы для документа Word mlreportgen.dom.DOCXPageHeader объект

Свойства

Children - Дочерние элементы элемента документа массив объектов DOM

CurrentHoleId - идентификатор текущего отверстия в документе вектор символов

CurrentHoleType - Тип текущего отверстия 'Inline' | 'Block'

CurrentPageLayout - Текущий макет страницы этого документа mlreportgen.dom.DOCXPageLayout | объекта mlreportgen.dom.PDFPageLayout объект

Id - идентификатор для этого элемента документа вектор символов | строковый скаляр

PageType - Тип заголовка страниц появляется на [] (по умолчанию) | default | first | even

Parent - Родительский элемент элемента документа Объект DOM

Tag - тег для этого элемента документа вектор символов | строковый скаляр

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

Методы

См. также

Темы

MATLAB Report Generator

Поддержка

`pageType` - Тип заголовка страниц появляется на
`[]` (по умолчанию) | `default` | `first` | `even`

`templatePath` - Полный путь к шаблону заголовка
вектор символов

`docPartTemplateName` - Имя шаблона детали документа
вектор символов

`templateSrc` - деталь документа или документа, содержащая шаблон детали документа;
`mlreportgen.dom.Document` | объекта `mlreportgen.dom.DocumentPart` объект

`docxHeader` - Заголовок страницы для документа Word
`mlreportgen.dom.DOCXPageHeader` объект

`Children` - Дочерние элементы элемента документа
массив объектов DOM

`CurrentHoleId` - идентификатор текущего отверстия в документе
вектор символов

`CurrentHoleType` - Тип текущего отверстия
`'Inline'` | `'Block'`

`CurrentPageLayout` - Текущий макет страницы этого документа
`mlreportgen.dom.DOCXPageLayout` | объекта `mlreportgen.dom.PDFPageLayout` объект

`Id` - идентификатор для этого элемента документа
вектор символов | строковый скаляр

`PageType` - Тип заголовка страниц появляется на
`[]` (по умолчанию) | `default` | `first` | `even`

`Parent` - Родительский элемент элемента документа
Объект DOM

`Tag` - тег для этого элемента документа
вектор символов | строковый скаляр

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