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
объект для части документа.
Выходные аргументы
развернуть все
Верхний колонтитул страницы для документа Word, возвращенного как mlreportgen.dom.DOCXPageHeader
объект.
Свойства
развернуть все
Children
— Дочерние элементы элемента документа
массив Объектов DOM
Дочерние элементы этого элемента документа в виде массива Объектов DOM. Это свойство доступно только для чтения.
CurrentHoleId
— ID текущего отверстия в документе
символьный вектор
Это свойство только для чтения является ID отверстия текущего отверстия в этом документе.
CurrentHoleType
— Тип текущего отверстия
'Inline'
| 'Block'
Тип текущего отверстия шаблона в виде 'Inline'
или 'Block'
.
Встроенное отверстие для элементов документа, которые может содержать элемент абзаца: Text
изображение
, LinkTarget
, ExternalLink
, InternalLink
, CharEntity
, AutoNumber
.
Отверстие блока может содержать Paragraph
Таблица
, OrderedList
, UnorderedList
, DocumentPart
, или Group
.
CurrentPageLayout
— Текущий макет страницы этого документа
mlreportgen.dom.DOCXPageLayout
возразите | mlreportgen.dom.PDFPageLayout
объект
Это свойство применяется к Word и документам в формате PDF. Для документов Word значением является DOCXPageLayout
объект, который задает текущий макет страницы. Для документов в формате PDF значением является PDFPageLayout
возразите, задает ли документ в настоящее время макет страницы. Для документов HTML значение всегда [].
Id
— ID для этого элемента документа
вектор символов | строковый скаляр
ID для этого элемента документа в виде вектора символов или строкового скаляра. DOM генерирует уникальный идентификатор сеанса, когда он создает элемент документа. Можно задать собственный ID.
PageType
— Тип заголовка страниц появляется на
[]
(значение по умолчанию) | default
| first
| even
Тип верхнего колонтитула страницы появляется на в виде одного из этих значений:
default
— Заголовок для нечетных страниц раздела, четные страницы, если вы не задаете заголовок четной страницы и первую страницу, если вы не задаете первый верхний колонтитул страницы.
first
— Заголовок для первой страницы раздела.
even
— Заголовок для четных страниц в разделе.
Например, чтобы иметь пустой заголовок появляются на первой странице, и различный заголовок появляются на других страницах, задают два заголовка, один с pageType
установите на first
и другой с pageType
установите на default
.
Parent
— Родительский элемент элемента документа
Объект DOM
Родительский элемент этого элемента документа в виде Объекта DOM. Это свойство доступно только для чтения.
Tag
— Пометьте для этого элемента документа
вектор символов | строковый скаляр
Пометьте для этого элемента документа в виде вектора символов или строкового скаляра.
DOM генерирует уникальный для сеанса тег как часть создания этого объекта. Сгенерированный тег имеет форму CLASS:ID, где КЛАСС является классом объекта, и ID является значением Id
свойство объекта. Определение вашего собственного значения тега может помочь вам идентифицировать, где проблема произошла во время генерации документов.
TemplatePath
— Путь к шаблону используется для заголовка
символьный вектор
Полный путь к шаблону, чтобы использовать для этого заголовка в виде вектора символов.
Методы
Используйте DOCXPageHeader
методы, когда вы используете соответствующий Document
методы.
Метод | Цель |
---|
append
| Добавьте один из этих Объектов DOM к заголовку: CustomElement
DOCXPageLayout
FormalTable
Group
ExternalLink
Image
InternalLink
OrderedList
Paragraph
RawText
Table
Text
UnorderedList
|
close
| Закройте заголовок. |
fill
| Заполните отверстие шаблона. |
moveToNextHole
| Переместитесь, чтобы затем обработать отверстие по шаблону. |
open
| Открытый заголовок. |