класс mlreportgen.dom.DOCXPageHeader

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

Описание

Строительство

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

`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

Поддержка

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

класс mlreportgen.dom.DOCXPageHeader

Описание

Строительство

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

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

Поддержка

`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` - путь к шаблону, используемому для заголовка;
символьный вектор