mlreportgen.dom.PageBorder class

Пакет: mlreportgen.dom

Границы страницы для Microsoft Word и макетов страницы PDF

Описание

Используйте объект mlreportgen.dom.PageBorder класс, чтобы задать границы страницы для Microsoft® Word и отчеты PDF.

mlreportgen.dom.PageBorder классом является handle класс.

Атрибуты класса

ConstructOnLoad
true
HandleCompatible
true

Для получения информации об атрибутах класса см. Атрибуты класса.

Создание

Описание

pageBorder = mlreportgen.dom.PageBorder() создает PageBorder объект со свойствами по умолчанию, где все сегменты являются твердыми, черными, и 0.5, указывает широкий, верхние и нижние сегменты являются одной точкой от полей страницы, и левые и правые сегменты являются четырьмя точками от полей страницы.

pageBorder = mlreportgen.dom.PageBorder(style) задает стиль по умолчанию для всех сегментов границы и устанавливает Style свойство к style.

pageBorder = mlreportgen.dom.PageBorder(style,color) также задает цвет по умолчанию для всех сегментов границы и устанавливает Color свойство к color.

пример

pageBorder = mlreportgen.dom.PageBorder(style,color,width) также задает ширину по умолчанию для всех сегментов границы и устанавливает Width свойство к width.

пример

pageBorder = mlreportgen.dom.PageBorder(style,color,width,margin) также задает поле по умолчанию для всех сегментов границы и устанавливает Margin свойство к margin.

Свойства

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

Стиль по умолчанию сегментов границы страницы в виде одного из значений в таблице.

Стиль границОписаниеПоддерживаемые выходные типы
"dashed"Пунктирная линияWord, PDF
"dashdotstroked"Линия с переменными диагональными тире и точкойWord
"dashsmallgap"Пунктирная линия с маленьким разрывом между тиреWord
"dotted"Пунктирная линияWord, PDF
"dotdash"Линия с чередованием точек и тиреWord
"dotdotdash"Линия с чередованием двойных точек и тиреWord
"double"Двойная линияWord, PDF
"doublewave"Удвойте волнистую линиюWord
"inset"3-D линия эффектаWord, PDF
"none"Никакая границаWord, PDF
"outset"3-D линия эффектаWord, PDF
"single"Одна строкаWord
"solid"Одна строкаPDF
"thick"Толстая линияDOCX
"thickthinlargegap"Пунктирная линия с чередованием толстых и тонких тире с большим разрывомDOCX
"thickthinmediumgap"Пунктирная линия с чередованием толстых и тонких тире со средним разрывомDOCX
"thickthinsmallgap"Пунктирная линия с чередованием толстых и тонких тире с маленьким разрывомDOCX
"thinthicklargegap"Пунктирная линия с переменными тонкими и толстыми тире с большим разрывомDOCX
"thinthickmediumgap"Пунктирная линия с переменными тонкими и толстыми тире со средним разрывомDOCX
"thinthicksmallgap"Пунктирная линия с переменными тонкими и толстыми тире с маленьким разрывомDOCX
"thinthickthinlargegap"Пунктирная линия с переменными тонкими и толстыми тире с большим разрывомDOCX
"thinthickthinmediumgap"Пунктирная линия с переменными тонкими и толстыми тире со средним разрывомDOCX
"thinthickthinsmallgap"Пунктирная линия с переменными тонкими и толстыми тире с маленьким разрывомDOCX
"threedemboss"Рельефная линия эффектаDOCX
"threedengrave"Выгравированная линия эффектаDOCX
"triple"Тройная линияDOCX
"wave"Волнистая линияDOCX

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Цвет по умолчанию сегментов границы в виде строкового скаляра или вектора символов, который содержит название цвета или эквивалентную шестнадцатеричную спецификацию RGB. См. https://www.w3.org/TR/2018/REC-css-color-3-20180619/.

Пример: "red"

Пример: "#FF0000"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Ширина по умолчанию сегментов границы страницы в виде вектора символов или строкового скаляра, который состоит из номера, сопровождаемого сокращением от единицы измерения. Например, "1 ПБ" задает одну точку. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Примечание

Соблюдает ли Word Width установка зависит от стиля, заданного Style свойство. Например, Word поддерживает только ширины с 1.5 точками и с 0.75 точками для wave стиль. Видеть ширины, что поддержки Word стиля границ, в Word, на вкладке Design, под Page Background, выбирают Page Borders. Выберите границу под Style, затем кликните по списку Width, чтобы видеть доступные ширины.

Пример: "1pt"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Поле по умолчанию сегментов границы страницы в виде строкового скаляра или вектора символов, который состоит из номера, сопровождаемого сокращением от единицы измерения. Например, "10 ПБ" задает десять точек. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Для документов в формате PDF поле сегмента границы является пробелом между сегментом и полем страницы. Для документов Word поле сегмента границы является пробелом между сегментом и полем страницы или между сегментом и ребром страницы, в зависимости от значения MeasureFrom свойство.

Для документов Word, Margin значение должно между 0 точками и 31 точкой или эквивалентной стоимостью с помощью других единиц измерения.

Пример: "10pt"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Измеряется ли положение границы от ребра страницы или ребра поля страницы, которое является ребром текста в виде "text" или "pageboundary". "pageboundary" значение применяется только к документам Word. Для документа в формате PDF граница страницы всегда измеряется от поля страницы.

Если значением является "text", Margin, TopMargin, LeftMargin, BottomMargin, и RightMargin свойства задают расстояние между сегментом границы и полем страницы. Например, в этом документе Word, поле страницы составляет один дюйм, и граница является двадцатью точками от поля страницы.

Arrow measuring a one-inch page margin stretches from the top page edge to the text. Another arrow for the border margin stretches between the border and the text.

Если значением является "pageboundary", значение Margin, TopMargin, LeftMargin, BottomMargin, и RightMargin свойства задают расстояние между границей и ребром страницы. Например, граница является 20 точками от ребра страницы в этом документе Word:

Arrow showing a 20-point border margin stretches between the page border and the page edge.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Окружает ли граница страницы область заголовка в виде true или false. Это свойство применяется к документам в формате PDF или документам Word когда MeasureFrom свойство установлено в "текст".

Если значением является true, граница окружает заголовок. Например, граница окружает заголовок в этом документе Word:

The page header content, "This is the header", is inside the solid black border.

Если значением является false, граница не окружает заголовок. Например, граница не окружает заголовок в этом документе Word:

The page header content, "This is the header", is outside of the solid black border.

Примечание

Для документов Word с несколькими разделами, false значение для SurroundHeader свойство или эквивалентная установка в шаблоне, применяется ко всем разделам документа. Если вы указываете, что граница страницы не окружает заголовок для одного раздела документа, граница страницы не окружает заголовок ни для какого раздела.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Окружает ли граница страницы область нижнего колонтитула в виде true или false. Это свойство применяется к документам в формате PDF или документам Word когда MeasureFrom свойство установлено в "текст".

Если значением является true, граница окружает нижний колонтитул. Например, граница окружает нижний колонтитул в этом документе Word:

The page footer content, "This is the footer", is inside the solid black border.

Если значением является false, граница не окружает нижний колонтитул. Например, граница не окружает нижний колонтитул в этом документе Word:

The page footer content, "This is the footer", is outside the solid black border.

Примечание

Для документов Word с несколькими разделами, false значение для SurroundFooter свойство или эквивалентная установка в шаблоне, применяется ко всем разделам документа. Если вы указываете, что граница страницы не окружает нижний колонтитул для одного раздела документа, граница страницы не окружает нижний колонтитул ни для какого раздела.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Стиль главного сегмента границы страницы в виде одного из значений в таблице.

Стиль границОписаниеПоддерживаемые выходные типы
"dashed"Пунктирная линияWord, PDF
"dashdotstroked"Линия с переменными диагональными тире и точкойWord
"dashsmallgap"Пунктирная линия с маленьким разрывом между тиреWord
"dotted"Пунктирная линияWord, PDF
"dotdash"Линия с чередованием точек и тиреWord
"dotdotdash"Линия с чередованием двойных точек и тиреWord
"double"Двойная линияWord, PDF
"doublewave"Удвойте волнистую линиюWord
"inset"3-D линия эффектаWord, PDF
"none"Никакая границаWord, PDF
"outset"3-D линия эффектаWord, PDF
"single"Одна строкаWord
"solid"Одна строкаPDF
"thick"Толстая линияDOCX
"thickthinlargegap"Пунктирная линия с чередованием толстых и тонких тире с большим разрывомDOCX
"thickthinmediumgap"Пунктирная линия с чередованием толстых и тонких тире со средним разрывомDOCX
"thickthinsmallgap"Пунктирная линия с чередованием толстых и тонких тире с маленьким разрывомDOCX
"thinthicklargegap"Пунктирная линия с переменными тонкими и толстыми тире с большим разрывомDOCX
"thinthickmediumgap"Пунктирная линия с переменными тонкими и толстыми тире со средним разрывомDOCX
"thinthicksmallgap"Пунктирная линия с переменными тонкими и толстыми тире с маленьким разрывомDOCX
"thinthickthinlargegap"Пунктирная линия с переменными тонкими и толстыми тире с большим разрывомDOCX
"thinthickthinmediumgap"Пунктирная линия с переменными тонкими и толстыми тире со средним разрывомDOCX
"thinthickthinsmallgap"Пунктирная линия с переменными тонкими и толстыми тире с маленьким разрывомDOCX
"threedemboss"Рельефная линия эффектаDOCX
"threedengrave"Выгравированная линия эффектаDOCX
"triple"Тройная линияDOCX
"wave"Волнистая линияDOCX

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Цвет сегмента верхней границы в виде строкового скаляра или вектора символов, который содержит название цвета или эквивалентную шестнадцатеричную спецификацию RGB. См. https://www.w3.org/TR/2018/REC-css-color-3-20180619/.

Пример: "red"

Пример: "#FF0000"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Ширина сегмента верхней границы в виде вектора символов или строкового скаляра, который состоит из номера, сопровождаемого сокращением от единицы измерения. Например, "1 ПБ" задает одну точку. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Примечание

Соблюдает ли Word TopWidth установка зависит от стиля, заданного TopStyle свойство. Например, Word поддерживает только ширины с 1.5 точками и с 0.75 точками для wave стиль. Видеть ширины, что поддержки Word стиля границ, в Word, на вкладке Design, под Page Background, выбирают Page Borders. Выберите границу под Style, затем кликните по списку Width, чтобы видеть доступные ширины.

Пример: "1pt"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Поле сегмента верхней границы в виде строкового скаляра или вектора символов, который состоит из номера, сопровождаемого сокращением от единицы измерения. Например, "10 ПБ" задает десять точек. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Для документов в формате PDF поле сегмента границы является пробелом между сегментом и полем страницы. Для документов Word поле сегмента границы является пробелом между сегментом и полем страницы или между сегментом и ребром страницы, в зависимости от значения MeasureFrom свойство.

Для документов Word, TopMargin значение должно между 0 точками и 31 точкой или эквивалентной стоимостью с помощью других единиц измерения.

Пример: "10pt"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Стиль левого сегмента границы в виде одного из значений в таблице.

Стиль границОписаниеПоддерживаемые выходные типы
"dashed"Пунктирная линияWord, PDF
"dashdotstroked"Линия с переменными диагональными тире и точкойWord
"dashsmallgap"Пунктирная линия с маленьким разрывом между тиреWord
"dotted"Пунктирная линияWord, PDF
"dotdash"Линия с чередованием точек и тиреWord
"dotdotdash"Линия с чередованием двойных точек и тиреWord
"double"Двойная линияWord, PDF
"doublewave"Удвойте волнистую линиюWord
"inset"3-D линия эффектаWord, PDF
"none"Никакая границаWord, PDF
"outset"3-D линия эффектаWord, PDF
"single"Одна строкаWord
"solid"Одна строкаPDF
"thick"Толстая линияDOCX
"thickthinlargegap"Пунктирная линия с чередованием толстых и тонких тире с большим разрывомDOCX
"thickthinmediumgap"Пунктирная линия с чередованием толстых и тонких тире со средним разрывомDOCX
"thickthinsmallgap"Пунктирная линия с чередованием толстых и тонких тире с маленьким разрывомDOCX
"thinthicklargegap"Пунктирная линия с переменными тонкими и толстыми тире с большим разрывомDOCX
"thinthickmediumgap"Пунктирная линия с переменными тонкими и толстыми тире со средним разрывомDOCX
"thinthicksmallgap"Пунктирная линия с переменными тонкими и толстыми тире с маленьким разрывомDOCX
"thinthickthinlargegap"Пунктирная линия с переменными тонкими и толстыми тире с большим разрывомDOCX
"thinthickthinmediumgap"Пунктирная линия с переменными тонкими и толстыми тире со средним разрывомDOCX
"thinthickthinsmallgap"Пунктирная линия с переменными тонкими и толстыми тире с маленьким разрывомDOCX
"threedemboss"Рельефная линия эффектаDOCX
"threedengrave"Выгравированная линия эффектаDOCX
"triple"Тройная линияDOCX
"wave"Волнистая линияDOCX

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Цвет левого сегмента границы в виде строкового скаляра или вектора символов, который содержит название цвета или эквивалентную шестнадцатеричную спецификацию RGB. См. https://www.w3.org/TR/2018/REC-css-color-3-20180619/.

Пример: "red"

Пример: "#FF0000"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Ширина левого сегмента границы в виде вектора символов или строкового скаляра, который состоит из номера, сопровождаемого сокращением от единицы измерения. Например, "1 ПБ" задает одну точку. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Примечание

Соблюдает ли Word LeftWidth установка зависит от стиля, заданного LeftStyle свойство. Например, Word поддерживает только ширины с 1.5 точками и с 0.75 точками для wave стиль. Видеть ширины, что поддержки Word стиля границ, в Word, на вкладке Design, под Page Background, выбирают Page Borders. Выберите границу под Style, затем кликните по списку Width, чтобы видеть доступные ширины.

Пример: "1pt"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Поле левого сегмента границы в виде строкового скаляра или вектора символов, который состоит из номера, сопровождаемого сокращением от единицы измерения. Например, "10 ПБ" задает десять точек. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Для документов в формате PDF поле сегмента границы является пробелом между сегментом и полем страницы. Для документов Word поле сегмента границы является пробелом между сегментом и полем страницы или между сегментом и ребром страницы, в зависимости от значения MeasureFrom свойство.

Для документов Word, LeftMargin значение должно между 0 точками и 31 точкой или эквивалентной стоимостью с помощью других единиц измерения.

Пример: "10pt"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Стиль сегмента нижней границы в виде одного из значений в таблице.

Стиль границОписаниеПоддерживаемые выходные типы
"dashed"Пунктирная линияWord, PDF
"dashdotstroked"Линия с переменными диагональными тире и точкойWord
"dashsmallgap"Пунктирная линия с маленьким разрывом между тиреWord
"dotted"Пунктирная линияWord, PDF
"dotdash"Линия с чередованием точек и тиреWord
"dotdotdash"Линия с чередованием двойных точек и тиреWord
"double"Двойная линияWord, PDF
"doublewave"Удвойте волнистую линиюWord
"inset"3-D линия эффектаWord, PDF
"none"Никакая границаWord, PDF
"outset"3-D линия эффектаWord, PDF
"single"Одна строкаWord
"solid"Одна строкаPDF
"thick"Толстая линияDOCX
"thickthinlargegap"Пунктирная линия с чередованием толстых и тонких тире с большим разрывомDOCX
"thickthinmediumgap"Пунктирная линия с чередованием толстых и тонких тире со средним разрывомDOCX
"thickthinsmallgap"Пунктирная линия с чередованием толстых и тонких тире с маленьким разрывомDOCX
"thinthicklargegap"Пунктирная линия с переменными тонкими и толстыми тире с большим разрывомDOCX
"thinthickmediumgap"Пунктирная линия с переменными тонкими и толстыми тире со средним разрывомDOCX
"thinthicksmallgap"Пунктирная линия с переменными тонкими и толстыми тире с маленьким разрывомDOCX
"thinthickthinlargegap"Пунктирная линия с переменными тонкими и толстыми тире с большим разрывомDOCX
"thinthickthinmediumgap"Пунктирная линия с переменными тонкими и толстыми тире со средним разрывомDOCX
"thinthickthinsmallgap"Пунктирная линия с переменными тонкими и толстыми тире с маленьким разрывомDOCX
"threedemboss"Рельефная линия эффектаDOCX
"threedengrave"Выгравированная линия эффектаDOCX
"triple"Тройная линияDOCX
"wave"Волнистая линияDOCX

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Цвет сегмента нижней границы в виде строкового скаляра или вектора символов, который содержит название цвета или эквивалентную шестнадцатеричную спецификацию RGB. См. https://www.w3.org/TR/2018/REC-css-color-3-20180619/.

Пример: "red"

Пример: "#FF0000"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Ширина сегмента нижней границы в виде вектора символов или строкового скаляра, который состоит из номера, сопровождаемого сокращением от единицы измерения. Например, "1 ПБ" задает одну точку. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Примечание

Соблюдает ли Word BottomWidth установка зависит от стиля, заданного BottomStyle свойство. Например, Word поддерживает только ширины с 1.5 точками и с 0.75 точками для wave стиль. Видеть ширины, что поддержки Word стиля границ, в Word, на вкладке Design, под Page Background, выбирают Page Borders. Выберите границу под Style, затем кликните по списку Width, чтобы видеть доступные ширины.

Пример: "1pt"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Поле сегмента нижней границы в виде строкового скаляра или вектора символов, который состоит из номера, сопровождаемого сокращением от единицы измерения. Например, "10 ПБ" задает десять точек. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Для документов в формате PDF поле сегмента границы является пробелом между сегментом и полем страницы. Для документов Word поле сегмента границы является пробелом между сегментом и полем страницы или между сегментом и ребром страницы, в зависимости от значения MeasureFrom свойство.

Для документов Word, BottomMargin значение должно между 0 точками и 31 точкой или эквивалентной стоимостью с помощью других единиц измерения.

Пример: "10pt"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Стиль правильного сегмента границы в виде одного из значений в таблице.

Стиль границОписаниеПоддерживаемые выходные типы
"dashed"Пунктирная линияWord, PDF
"dashdotstroked"Линия с переменными диагональными тире и точкойWord
"dashsmallgap"Пунктирная линия с маленьким разрывом между тиреWord
"dotted"Пунктирная линияWord, PDF
"dotdash"Линия с чередованием точек и тиреWord
"dotdotdash"Линия с чередованием двойных точек и тиреWord
"double"Двойная линияWord, PDF
"doublewave"Удвойте волнистую линиюWord
"inset"3-D линия эффектаWord, PDF
"none"Никакая границаWord, PDF
"outset"3-D линия эффектаWord, PDF
"single"Одна строкаWord
"solid"Одна строкаPDF
"thick"Толстая линияDOCX
"thickthinlargegap"Пунктирная линия с чередованием толстых и тонких тире с большим разрывомDOCX
"thickthinmediumgap"Пунктирная линия с чередованием толстых и тонких тире со средним разрывомDOCX
"thickthinsmallgap"Пунктирная линия с чередованием толстых и тонких тире с маленьким разрывомDOCX
"thinthicklargegap"Пунктирная линия с переменными тонкими и толстыми тире с большим разрывомDOCX
"thinthickmediumgap"Пунктирная линия с переменными тонкими и толстыми тире со средним разрывомDOCX
"thinthicksmallgap"Пунктирная линия с переменными тонкими и толстыми тире с маленьким разрывомDOCX
"thinthickthinlargegap"Пунктирная линия с переменными тонкими и толстыми тире с большим разрывомDOCX
"thinthickthinmediumgap"Пунктирная линия с переменными тонкими и толстыми тире со средним разрывомDOCX
"thinthickthinsmallgap"Пунктирная линия с переменными тонкими и толстыми тире с маленьким разрывомDOCX
"threedemboss"Рельефная линия эффектаDOCX
"threedengrave"Выгравированная линия эффектаDOCX
"triple"Тройная линияDOCX
"wave"Волнистая линияDOCX

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Цвет правильного сегмента границы в виде строкового скаляра или вектора символов, который содержит название цвета или эквивалентную шестнадцатеричную спецификацию RGB. См. https://www.w3.org/TR/2018/REC-css-color-3-20180619/.

Пример: "red"

Пример: "#FF0000"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Ширина правильного сегмента границы в виде вектора символов или строкового скаляра, который состоит из номера, сопровождаемого сокращением от единицы измерения. Например, "1 ПБ" задает одну точку. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Примечание

Соблюдает ли Word RightWidth установка зависит от стиля, заданного RightStyle свойство. Например, Word поддерживает только ширины с 1.5 точками и с 0.75 точками для wave стиль. Видеть ширины, что поддержки Word стиля границ, в Word, на вкладке Design, под Page Background, выбирают Page Borders. Выберите границу под Style, затем кликните по списку Width, чтобы видеть доступные ширины.

Пример: "1pt"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Поле правильного сегмента границы в виде строкового скаляра или вектора символов, который состоит из номера, сопровождаемого сокращением от единицы измерения. Например, "10 ПБ" задает десять точек. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Для документов в формате PDF поле сегмента границы является пробелом между сегментом и полем страницы. Для документов Word поле сегмента границы является пробелом между сегментом и полем страницы или между сегментом и ребром страницы, в зависимости от значения MeasureFrom свойство.

Для документов Word, RightMargin значение должно между 0 точками и 31 точкой или эквивалентной стоимостью с помощью других единиц измерения.

Пример: "10pt"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Пометьте для этого объекта DOM API в виде вектора символов или строкового скаляра.

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

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

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

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Примеры

свернуть все

Этот пример генерирует документ Microsoft Word, который имеет твердые, красные, границы с 0.5 точками, расположенные 20 точек от контура страницы.

Импортируйте пакет API DOM так, чтобы вы не использовали долго, полностью определенные имена классов.

import mlreportgen.dom.*;

Создайте документ Word.

d = Document("myDocument","docx");
open(d);

Создайте PageBorder возразите и задайте стиль границ, цвет и ширину.

pageBorder = PageBorder("solid","red","0.5pt");

Укажите, что положение границы относительно контура страницы, и задайте поле между контуром страницы и границей.

pageBorder.MeasureFrom ="pageboundary";
pageBorder.Margin = "20pt";

Установите PageBorder свойство размещения, сопоставленного с документом PageBorder объект.

d.CurrentPageLayout.PageBorder = pageBorder;

Добавьте текст в документ. Закройте и просмотрите документ.

append(d,"The solid, red, 0.5-point border is 20 points from the page boundary.");
close(d);
rptview(d);

Этот пример генерирует документ в формате PDF, который имеет твердые, красные, границы с 0.5 точками, расположенные 20 точек от полей страницы.

Импортируйте пакет API DOM так, чтобы вы не использовали долго, полностью определенные имена классов.

import mlreportgen.dom.*;

Создайте документ в формате PDF.

d = Document("myDocument","pdf");
open(d);

Создайте PageBorder возразите и задайте стиль, цвет, ширину и поле для всех сегментов границы. Для Документов в формате PDF поле сегмента границы задает расстояние между сегментом и полем страницы.

pageBorder = PageBorder("solid","red","0.5pt","20pt");

Установите PageBorder свойство размещения, сопоставленного с документом PageBorder объект.

d.CurrentPageLayout.PageBorder = pageBorder;

Добавьте текст в документ. Закройте и просмотрите документ.

append(d,"The solid, red, 0.5-point border segments are twenty points from the margins.");
close(d);
rptview(d);

Этот пример использует API Отчета, чтобы сгенерировать Word или отчет PDF, который имеет красные границы страницы на титульном листе и синие границы страницы на других разделах отчета.

Импортируйте API Отчета и пакеты API DOM так, чтобы вы не использовали долго, полностью определенные имена классов.

import mlreportgen.report.*;
import mlreportgen.dom.*;

Создайте отчет Word и задайте твердые, синие, границы по умолчанию с 0.5 точками для всех страниц отчета. Для отчета PDF замените "docx" с "pdf".

rpt = Report("myreport","docx");
rpt.Layout.PageBorder = PageBorder("solid","blue","0.5pt");

Создайте титульный лист и задайте твердые, красные, границы с 0.5 точками для титульного листа. Добавьте титульный лист к отчету.

tp = TitlePage("Title","My Report");
tp.Layout.PageBorder = PageBorder("solid","red","0.5pt");
append(rpt,tp);

Создайте главу и добавьте ее к отчету.

ch = Chapter("My Chapter");
append(rpt,ch);

Закройте и просмотрите отчет.

close(rpt);
rptview(rpt);

В сгенерированном отчете титульный лист имеет красные границы, как задано размещением генератора отчетов титульного листа.

Страницы главы имеют синие границы по умолчанию, потому что размещение генератора отчетов главы не задавало границы страницы.

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