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

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

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

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

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

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

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

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

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

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

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

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

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

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

Свойства

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

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

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

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

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

  • Дыра блока может содержать Paragraph, Table, OrderedList, UnorderedList, DocumentPart или Group.

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

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

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

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

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

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

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

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

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

Уникальный идентификатор сеанса сгенерирован как часть создания элемента документа. Сгенерированный тег имеет форму 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

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