Word.PageSetup class

Пакет:
word

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

Extends
OfficeExtension.ClientObject

Комментарии

Набор API: WordApiDesktop 1.3

Используется

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-section-starts.yaml

await Word.run(async (context) => {

  // Configure document-wide page settings for a report that will be printed and bound.
  const pageSetup: Word.PageSetup = context.document.pageSetup;
  pageSetup.set({
    paperSize: Word.PaperSize.letter,
    orientation: Word.PageOrientation.portrait,
    topMargin: 72,
    bottomMargin: 72,
    leftMargin: 90,
    rightMargin: 72,
    gutter: 18,
    gutterPosition: Word.GutterPosition.left,
    mirrorMargins: true,
    oddAndEvenPagesHeaderFooter: true
  });

  const sections: Word.SectionCollection = context.document.sections;
  sections.load("items");
  await context.sync();

  // Start the main chapter on an odd-numbered page so it appears on the right in a bound document.
  const chapterPageSetup: Word.PageSetup = sections.items[1].pageSetup;
  chapterPageSetup.sectionStart = Word.SectionStart.oddPage;
  chapterPageSetup.differentFirstPageHeaderFooter = true;

  // Keep the appendix in a separate section, but let it begin on the current page.
  sections.items[2].pageSetup.sectionStart = Word.SectionStart.continuous;

  await context.sync();
  console.log("Applied print and binding settings to the report.");
});

Свойства

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

Комментарии

Набор API: WordApiDesktop 1.3

bookFoldPrintingSheets

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

bookFoldPrintingSheets: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

bookFoldReversePrinting

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

bookFoldReversePrinting: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.3

bottomMargin

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

bottomMargin: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

charsLine

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

charsLine: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

context

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

context: RequestContext;

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

Word.RequestContext

differentFirstPageHeaderFooter

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

differentFirstPageHeaderFooter: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.3

footerDistance

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

footerDistance: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

gutter

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

gutter: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

gutterPosition

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

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

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

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

Комментарии

Набор API: WordApiDesktop 1.3

gutterStyle

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

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

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

Word.GutterStyle | "Bidirectional" | "Latin"

Комментарии

Набор API: WordApiDesktop 1.3

headerDistance

Определяет расстояние между верхним колонтитулом и верхом страницы в точках.

headerDistance: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

layoutMode

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

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

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

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

Комментарии

Набор API: WordApiDesktop 1.3

leftMargin

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

leftMargin: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

lineNumbering

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

lineNumbering: Word.LineNumbering;

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

Word.LineNumbering

Комментарии

Набор API: WordApiDesktop 1.3

linesPage

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

linesPage: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

mirrorMargins

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

mirrorMargins: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.3

oddAndEvenPagesHeaderFooter

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

oddAndEvenPagesHeaderFooter: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.3

orientation

Определяет ориентацию страницы.

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

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

Word.PageOrientation | "Portrait" | "Landscape"

Комментарии

Набор API: WordApiDesktop 1.3

pageHeight

Высота страницы в точках.

pageHeight: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

pageWidth

Ширина страницы в точках.

pageWidth: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

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";

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

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"

Комментарии

Набор API: WordApiDesktop 1.3

rightMargin

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

rightMargin: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

sectionDirection

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

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

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

Word.SectionDirection | "RightToLeft" | "LeftToRight"

Комментарии

Набор API: WordApiDesktop 1.3

sectionStart

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

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

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

Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"

Комментарии

Набор API: WordApiDesktop 1.3

showGrid

Указывает, нужно ли показывать сетку.

showGrid: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.3

suppressEndnotes

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

suppressEndnotes: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.3

textColumns

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

readonly textColumns: Word.TextColumnCollection;

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

Word.TextColumnCollection

Комментарии

Набор API: WordApiDesktop 1.3

topMargin

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

topMargin: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

twoPagesOnOne

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

twoPagesOnOne: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.3

verticalAlignment

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

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

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

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

Комментарии

Набор API: WordApiDesktop 1.3

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

load(options)

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

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

Параметры

options
Word.Interfaces.PageSetupLoadOptions

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

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

Word.PageSetup

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.PageSetup

load(propertyNamesAndPaths)

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

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

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

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

void

set(properties)

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

set(properties: Word.PageSetup): void;

Параметры

properties
Word.PageSetup

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

void

setAsTemplateDefault()

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

setAsTemplateDefault(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.3

togglePortrait()

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

togglePortrait(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.3

toJSON()

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

toJSON(): Word.Interfaces.PageSetupData;

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

Word.Interfaces.PageSetupData

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-section-starts.yaml

await Word.run(async (context) => {
  const pageSetup: Word.PageSetup = context.document.pageSetup;
  pageSetup.load();

  const sections: Word.SectionCollection = context.document.sections;
  sections.load("items");
  await context.sync();

  sections.items.forEach((section) => section.pageSetup.load("sectionStart"));
  await context.sync();

  console.log("Document page setup:", pageSetup.toJSON());
  sections.items.forEach((section, index) => {
    console.log(`Section ${index + 1} starts: ${section.pageSetup.sectionStart}`);
  });
});

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