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) создает верхний колонтитул страницы для заданного типа страницы, на основе заданного шаблона части документа, используемого заданным источником. Источник может быть документом или частью документа.

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

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

Тип верхнего колонтитула страницы кажется на, заданным как одно из этих значений:

  • default — Заголовок для нечетных страниц раздела, четные страницы, если вы не задаете заголовок четной страницы и первую страницу, если вы не задаете первый верхний колонтитул страницы.

  • first — Заголовок для первой страницы раздела.

  • even — Заголовок для четных страниц в разделе.

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

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

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

Документ или часть документа возражают, чей шаблон содержит шаблон для этой части документа, заданной как mlreportgen.dom.Document объект для документа или mlreportgen.dom.DocumentPart объект для части документа.

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

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

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

Свойства

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

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

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

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

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

  • Отверстие блока может содержать ParagraphТаблица, OrderedList, UnorderedList, DocumentPart, или Group.

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

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

Тип верхнего колонтитула страницы кажется на, заданным как одно из этих значений:

  • default — Заголовок для нечетных страниц раздела, четные страницы, если вы не задаете заголовок четной страницы и первую страницу, если вы не задаете первый верхний колонтитул страницы.

  • first — Заголовок для первой страницы раздела.

  • even — Заголовок для четных страниц в разделе.

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

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

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

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

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

Методы

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

Метод

Цель

append

Добавьте один из этих Объектов DOM к заголовку:

  • CustomElement

  • DOCXPageLayout

  • FormalTable

  • Group

  • ExternalLink

  • Image

  • InternalLink

  • OrderedList

  • Paragraph

  • RawText

  • Table

  • Text

  • UnorderedList

close

Закройте заголовок.

fill

Заполните отверстие шаблона.

moveToNextHole

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

open

Открытый заголовок.

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