Word.PageSetup class

Пакет:: word

Представляет параметры настройки страницы для Word документа или раздела.

Extends: OfficeExtension.ClientObject

Свойства

bookFoldPrinting	Указывает, печатает ли microsoft Word документ в виде брошюры.
bookFoldPrintingSheets	Указывает количество страниц для каждой брошюры.
bookFoldReversePrinting	Указывает, отменяет ли Microsoft Word порядок печати документов на двунаправленном или азиатском языке.
bottomMargin	Указывает расстояние (в точках) между нижним краем страницы и нижней границей основного текста.
charsLine	Указывает количество символов в строке в сетке документа.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
differentFirstPageHeaderFooter	Указывает, имеет ли первая страница разные верхние и нижние колонтитулы.
footerDistance	Указывает расстояние между нижним колонтитулом и нижней частью страницы в точках.
gutter	Указывает объем (в пунктах) дополнительного пространства полей, добавленного на каждую страницу в документе или разделе для привязки.
gutterPosition	Указывает, на какой стороне отображается желоб в документе.
gutterStyle	Указывает, использует ли Microsoft Word желоба для текущего документа на основе языка справа налево или языка слева направо.
headerDistance	Указывает расстояние между заголовком и верхней частью страницы в точках.
layoutMode	Задает режим макета для текущего документа.
leftMargin	Указывает расстояние (в точках) между левым краем страницы и левой границей основного текста.
lineNumbering	Указывает `LineNumbering` объект , представляющий номера строк для `PageSetup` объекта .
linesPage	Указывает количество строк на странице в сетке документа.
mirrorMargins	Указывает, имеют ли внутренние и внешние поля страниц одинаковой ширины.
oddAndEvenPagesHeaderFooter	Указывает, имеют ли нечетные и четные страницы разные верхние и нижние колонтитулы.
orientation	Задает ориентацию страницы.
pageHeight	Задает высоту страницы в точках.
pageWidth	Задает ширину страницы в точках.
paperSize	Задает размер бумаги страницы.
rightMargin	Указывает расстояние (в точках) между правым краем страницы и правой границей основного текста.
sectionDirection	Задает порядок чтения и выравнивание для указанных разделов.
sectionStart	Указывает тип разрыва раздела для указанного объекта.
showGrid	Указывает, следует ли отображать сетку.
suppressEndnotes	Указывает, печатаются ли концевые сноски в конце следующего раздела, который не подавляет концевые сноски.
textColumns	`TextColumnCollection` Возвращает объект , представляющий набор текстовых столбцов для `PageSetup` объекта .
topMargin	Указывает верхнее поле страницы в точках.
twoPagesOnOne	Указывает, следует ли печатать две страницы на листе.
verticalAlignment	Задает вертикальное выравнивание текста на каждой странице документа или раздела.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setAsTemplateDefault()	Задает указанное форматирование страницы по умолчанию для активного документа и всех новых документов на основе активного шаблона.
togglePortrait()	Переключение между книжной и альбомной ориентацией страницы для документа или раздела.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.PageSetup` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Word.Interfaces.PageSetupData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах `.sync` и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить `context.sync()` до того, как выпуск памяти вступит в силу.

Сведения о свойстве

bookFoldPrinting

Указывает, печатает ли microsoft Word документ в виде брошюры.

bookFoldPrinting: boolean;

Значение свойства

boolean

bookFoldPrintingSheets

Указывает количество страниц для каждой брошюры.

bookFoldPrintingSheets: number;

Значение свойства

number

bookFoldReversePrinting

Указывает, отменяет ли Microsoft Word порядок печати документов на двунаправленном или азиатском языке.

bookFoldReversePrinting: boolean;

Значение свойства

boolean

bottomMargin

Указывает расстояние (в точках) между нижним краем страницы и нижней границей основного текста.

bottomMargin: number;

Значение свойства

number

charsLine

Указывает количество символов в строке в сетке документа.

charsLine: number;

Значение свойства

number

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

differentFirstPageHeaderFooter

Указывает, имеет ли первая страница разные верхние и нижние колонтитулы.

differentFirstPageHeaderFooter: boolean;

Значение свойства

boolean

footerDistance

Указывает расстояние между нижним колонтитулом и нижней частью страницы в точках.

footerDistance: number;

Значение свойства

number

gutter

Указывает объем (в пунктах) дополнительного пространства полей, добавленного на каждую страницу в документе или разделе для привязки.

gutter: number;

Значение свойства

number

gutterPosition

Указывает, на какой стороне отображается желоб в документе.

gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top";

Значение свойства

Word.GutterPosition | "Left" | "Right" | "Top"

gutterStyle

Указывает, использует ли Microsoft Word желоба для текущего документа на основе языка справа налево или языка слева направо.

gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin";

Значение свойства

Word.GutterStyle | "Bidirectional" | "Latin"

headerDistance

Указывает расстояние между заголовком и верхней частью страницы в точках.

headerDistance: number;

Значение свойства

number

layoutMode

Задает режим макета для текущего документа.

layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko";

Значение свойства

Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"

leftMargin

Указывает расстояние (в точках) между левым краем страницы и левой границей основного текста.

leftMargin: number;

Значение свойства

number

lineNumbering

Указывает LineNumbering объект , представляющий номера строк для PageSetup объекта .

lineNumbering: Word.LineNumbering;

Значение свойства

Word.LineNumbering

linesPage

Указывает количество строк на странице в сетке документа.

linesPage: number;

Значение свойства

number

mirrorMargins

Указывает, имеют ли внутренние и внешние поля страниц одинаковой ширины.

mirrorMargins: boolean;

Значение свойства

boolean

oddAndEvenPagesHeaderFooter

Указывает, имеют ли нечетные и четные страницы разные верхние и нижние колонтитулы.

oddAndEvenPagesHeaderFooter: boolean;

Значение свойства

boolean

orientation

Задает ориентацию страницы.

orientation: Word.PageOrientation | "Portrait" | "Landscape";

Значение свойства

Word.PageOrientation | "Portrait" | "Landscape"

pageHeight

Задает высоту страницы в точках.

pageHeight: number;

Значение свойства

number

pageWidth

Задает ширину страницы в точках.

pageWidth: number;

Значение свойства

number

paperSize

Задает размер бумаги страницы.

paperSize: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom";

Значение свойства

rightMargin

Указывает расстояние (в точках) между правым краем страницы и правой границей основного текста.

rightMargin: number;

Значение свойства

number

sectionDirection

Задает порядок чтения и выравнивание для указанных разделов.

sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight";

Значение свойства

Word.SectionDirection | "RightToLeft" | "LeftToRight"

sectionStart

Указывает тип разрыва раздела для указанного объекта.

sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage";

Значение свойства

showGrid

Указывает, следует ли отображать сетку.

showGrid: boolean;

Значение свойства

boolean

suppressEndnotes

Указывает, печатаются ли концевые сноски в конце следующего раздела, который не подавляет концевые сноски.

suppressEndnotes: boolean;

Значение свойства

boolean

textColumns

TextColumnCollection Возвращает объект , представляющий набор текстовых столбцов для PageSetup объекта .

readonly textColumns: Word.TextColumnCollection;

Значение свойства

Word.TextColumnCollection

topMargin

Указывает верхнее поле страницы в точках.

topMargin: number;

Значение свойства

number

twoPagesOnOne

Указывает, следует ли печатать две страницы на листе.

twoPagesOnOne: boolean;

Значение свойства

boolean

verticalAlignment

Задает вертикальное выравнивание текста на каждой странице документа или раздела.

verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom";

Значение свойства

Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"

Сведения о методе

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Word.Interfaces.PageSetupLoadOptions): Word.PageSetup;

Параметры

options: Word.Interfaces.PageSetupLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Word.PageSetup

load(propertyNames)

load(propertyNames?: string | string[]): Word.PageSetup;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Word.PageSetup

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.PageSetup;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Word.PageSetup

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Word.Interfaces.PageSetupUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

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

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Word.PageSetup): void;

Параметры

properties: Word.PageSetup

Возвращаемое значение

void

setAsTemplateDefault()

Задает указанное форматирование страницы по умолчанию для активного документа и всех новых документов на основе активного шаблона.

setAsTemplateDefault(): void;

Возвращаемое значение

void

togglePortrait()

Переключение между книжной и альбомной ориентацией страницы для документа или раздела.

togglePortrait(): void;

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.PageSetup объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.PageSetupData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Word.Interfaces.PageSetupData;

Возвращаемое значение

Word.Interfaces.PageSetupData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.

track(): Word.PageSetup;

Возвращаемое значение

Word.PageSetup

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): Word.PageSetup;

Возвращаемое значение

Word.PageSetup

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через

Word.PageSetup class

Комментарии

Свойства

Методы

Сведения о свойстве

bookFoldPrinting

Значение свойства

Комментарии

bookFoldPrintingSheets

Значение свойства

Комментарии

bookFoldReversePrinting

Значение свойства

Комментарии

bottomMargin

Значение свойства

Комментарии

charsLine

Значение свойства

Комментарии

context

Значение свойства

differentFirstPageHeaderFooter

Значение свойства

Комментарии

footerDistance

Значение свойства

Комментарии

gutter

Значение свойства

Комментарии

gutterPosition

Значение свойства

Комментарии

gutterStyle

Значение свойства

Комментарии

headerDistance

Значение свойства

Комментарии

layoutMode

Значение свойства

Комментарии

leftMargin

Значение свойства

Комментарии

lineNumbering

Значение свойства

Комментарии

linesPage

Значение свойства

Комментарии

mirrorMargins

Значение свойства

Комментарии

oddAndEvenPagesHeaderFooter

Значение свойства

Комментарии

orientation

Значение свойства

Комментарии

pageHeight

Значение свойства

Комментарии

pageWidth

Значение свойства

Комментарии

paperSize

Значение свойства

Комментарии

rightMargin

Значение свойства

Комментарии

sectionDirection

Значение свойства

Комментарии

sectionStart

Значение свойства

Комментарии