Word.Window class

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

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets the first paragraph of each page.
  console.log("Getting first paragraph of each page...");

  // Get the active window.
  const activeWindow: Word.Window = context.document.activeWindow;
  activeWindow.load();

  // Get the active pane.
  const activePane: Word.Pane = activeWindow.activePane;
  activePane.load();

  // Get all pages.
  const pages: Word.PageCollection = activePane.pages;
  pages.load();

  await context.sync();

  // Get page index and paragraphs of each page.
  const pagesIndexes = [];
  const pagesNumberOfParagraphs = [];
  const pagesFirstParagraphText = [];
  for (let i = 0; i < pages.items.length; i++) {
    const page = pages.items[i];
    page.load("index");
    pagesIndexes.push(page);

    const paragraphs = page.getRange().paragraphs;
    paragraphs.load("items/length");
    pagesNumberOfParagraphs.push(paragraphs);

    const firstParagraph = paragraphs.getFirst();
    firstParagraph.load("text");
    pagesFirstParagraphText.push(firstParagraph);
  }

  await context.sync();

  for (let i = 0; i < pagesIndexes.length; i++) {
    console.log(`Page index: ${pagesIndexes[i].index}`);
    console.log(`Number of paragraphs: ${pagesNumberOfParagraphs[i].items.length}`);
    console.log("First paragraph's text:", pagesFirstParagraphText[i].text);
  }
});

Свойства

activePane	Возвращает активную область в окне.
areRulersDisplayed	Указывает, отображаются ли линейки для окна или области.
areScreenTipsDisplayed	Указывает, отображаются ли комментарии, сноски, концевые сноски и гиперссылки в виде подсказок.
areThumbnailsDisplayed	Указывает, отображаются ли эскизы страниц в документе в левой части окна документа Word Майкрософт.
caption	Указывает текст подпись для окна, отображаемого в строке заголовка окна документа или приложения.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
height	Задает высоту окна (в точках).
horizontalPercentScrolled	Задает положение горизонтальной прокрутки в процентах от ширины документа.
imeMode	Указывает режим запуска по умолчанию для редактора методов ввода (IME) на японском языке.
index	Возвращает положение элемента в коллекции.
isActive	Указывает, активно ли окно.
isDocumentMapVisible	Указывает, отображается ли карта документа.
isEnvelopeVisible	Указывает, отображается ли заголовок сообщения электронной почты в окне документа. Значение по умолчанию — `false`.
isHorizontalScrollBarDisplayed	Указывает, отображается ли горизонтальная полоса прокрутки для окна.
isLeftScrollBarDisplayed	Указывает, отображается ли вертикальная полоса прокрутки в левой части окна документа.
isRightRulerDisplayed	Указывает, отображается ли вертикальная линейка в правой части окна документа в режиме печати.
isSplit	Указывает, разделено ли окно на несколько областей.
isVerticalRulerDisplayed	Указывает, отображается ли вертикальная линейка для окна или области.
isVerticalScrollBarDisplayed	Указывает, отображается ли вертикальная полоса прокрутки для окна.
isVisible	Указывает, является ли окно видимым.
left	Задает горизонтальное положение окна, измеряемое в точках.
next	Возвращает следующее окно документа в коллекции открытых окон документов.
panes	Возвращает коллекцию панелей в окне.
previous	Возвращает предыдущее окно документа в открытых окнах документов коллекции.
showSourceDocuments	Указывает, как Microsoft Word отображает исходные документы после процесса сравнения и слияния.
splitVertical	Указывает процент вертикального разбиения для окна.
state	Указывает состояние окна документа или окна задач.
styleAreaWidth	Задает ширину области стиля в точках.
top	Задает вертикальное положение окна документа в точках.
type	Возвращает тип окна.
usableHeight	Возвращает высоту (в пунктах) активной рабочей области в окне документа.
usableWidth	Возвращает ширину (в точках) активной рабочей области в окне документа.
verticalPercentScrolled	Задает положение вертикальной прокрутки в процентах от длины документа.
view	`View` Возвращает объект , представляющий представление для окна.
width	Задает ширину окна документа в точках.
windowNumber	Возвращает целое число, представляющее положение окна.

Методы

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

activePane

Возвращает активную область в окне.

readonly activePane: Word.Pane;

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

Word.Pane

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets the pages enclosing the viewport.

  // Get the active window.
  const activeWindow: Word.Window = context.document.activeWindow;
  activeWindow.load();

  // Get the active pane.
  const activePane: Word.Pane = activeWindow.activePane;
  activePane.load();

  // Get pages enclosing the viewport.
  const pages: Word.PageCollection = activePane.pagesEnclosingViewport;
  pages.load();

  await context.sync();

  // Log the number of pages.
  const pageCount = pages.items.length;
  console.log(`Number of pages enclosing the viewport: ${pageCount}`);

  // Log index info of these pages.
  const pagesIndexes = [];
  for (let i = 0; i < pageCount; i++) {
    const page = pages.items[i];
    page.load("index");
    pagesIndexes.push(page);
  }

  await context.sync();

  for (let i = 0; i < pagesIndexes.length; i++) {
    console.log(`Page index: ${pagesIndexes[i].index}`);
  }
});

areRulersDisplayed

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

areRulersDisplayed: boolean;

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

boolean

areScreenTipsDisplayed

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

readonly areScreenTipsDisplayed: boolean;

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

boolean

areThumbnailsDisplayed

Указывает, отображаются ли эскизы страниц в документе в левой части окна документа Word Майкрософт.

areThumbnailsDisplayed: boolean;

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

boolean

caption

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

caption: string;

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

string

context

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

context: RequestContext;

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

Word.RequestContext

height

Задает высоту окна (в точках).

readonly height: number;

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

number

horizontalPercentScrolled

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

horizontalPercentScrolled: number;

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

number

imeMode

Указывает режим запуска по умолчанию для редактора методов ввода (IME) на японском языке.

imeMode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul";

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

index

Возвращает положение элемента в коллекции.

readonly index: number;

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

number

isActive

Указывает, активно ли окно.

readonly isActive: boolean;

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

boolean

isDocumentMapVisible

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

isDocumentMapVisible: boolean;

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

boolean

isEnvelopeVisible

Указывает, отображается ли заголовок сообщения электронной почты в окне документа. Значение по умолчанию — false.

isEnvelopeVisible: boolean;

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

boolean

isHorizontalScrollBarDisplayed

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

isHorizontalScrollBarDisplayed: boolean;

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

boolean

isLeftScrollBarDisplayed

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

isLeftScrollBarDisplayed: boolean;

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

boolean

isRightRulerDisplayed

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

isRightRulerDisplayed: boolean;

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

boolean

isSplit

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

isSplit: boolean;

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

boolean

isVerticalRulerDisplayed

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

isVerticalRulerDisplayed: boolean;

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

boolean

isVerticalScrollBarDisplayed

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

isVerticalScrollBarDisplayed: boolean;

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

boolean

isVisible

Указывает, является ли окно видимым.

isVisible: boolean;

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

boolean

left

Задает горизонтальное положение окна, измеряемое в точках.

readonly left: number;

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

number

panes

Возвращает коллекцию панелей в окне.

readonly panes: Word.PaneCollection;

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

Word.PaneCollection

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets all the panes in the active document window.

  // Get the active window.
  const activeWindow: Word.Window = context.document.activeWindow;
  activeWindow.load("panes/items/length");

  await context.sync();

  const panes: Word.PaneCollection = activeWindow.panes;
  console.log(`Number of panes in the current document window: ${panes.items.length}`);
});

showSourceDocuments

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

showSourceDocuments: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both";

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

Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"

splitVertical

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

splitVertical: number;

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

number

state

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

state: Word.WindowState | "Normal" | "Maximize" | "Minimize";

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

Word.WindowState | "Normal" | "Maximize" | "Minimize"

styleAreaWidth

Задает ширину области стиля в точках.

styleAreaWidth: number;

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

number

top

Задает вертикальное положение окна документа в точках.

readonly top: number;

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

number

type

Возвращает тип окна.

readonly type: Word.WindowType | "Document" | "Template";

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

Word.WindowType | "Document" | "Template"

usableHeight

Возвращает высоту (в пунктах) активной рабочей области в окне документа.

readonly usableHeight: number;

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

number

usableWidth

Возвращает ширину (в точках) активной рабочей области в окне документа.

readonly usableWidth: number;

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

number

verticalPercentScrolled

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

verticalPercentScrolled: number;

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

number

view

View Возвращает объект , представляющий представление для окна.

readonly view: Word.View;

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

Word.View

width

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

readonly width: number;

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

number

windowNumber

Возвращает целое число, представляющее положение окна.

readonly windowNumber: number;

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

number

activate()

Активирует окно.

activate(): void;

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

void

close(options)

Закрывает окно.

close(options?: Word.WindowCloseOptions): void;

Параметры

options: Word.WindowCloseOptions

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

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

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/close-document-window.yaml

await Word.run(async (context) => {
  // Closes the document window, prompting to save if this is a new document.
  const window: Word.Window = context.document.activeWindow;
  const closeOptions: Word.WindowCloseOptions = { saveChanges: Word.SaveConfiguration.promptToSaveChanges };
  console.log("About to close the document window...");
  window.close(closeOptions);
});

largeScroll(options)

Прокручивает окно на указанное количество экранов.

largeScroll(options?: Word.WindowScrollOptions): void;

Параметры

options: Word.WindowScrollOptions

Необязательный параметр. Параметры прокрутки окна на указанное количество экранов. Если параметры не указаны, окно прокручивается вниз на один экран.

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

void

load(options)

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

load(options?: Word.Interfaces.WindowLoadOptions): Word.Window;

Параметры

options: Word.Interfaces.WindowLoadOptions

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

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

Word.Window

load(propertyNames)

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

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

Параметры

propertyNames: string | string[]

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

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

Word.Window

load(propertyNamesAndPaths)

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

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

Параметры

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

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

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

Word.Window

pageScroll(options)

Прокручивает окно по страницам.

pageScroll(options?: Word.WindowPageScrollOptions): void;

Параметры

options: Word.WindowPageScrollOptions

Необязательный параметр. Параметры прокрутки окна по страницам.

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

void

set(properties, options)

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

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

Параметры

properties: Word.Interfaces.WindowUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Word.Window): void;

Параметры

properties: Word.Window

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

void

setFocus()

Задает фокус окна документа на текст сообщения электронной почты.

setFocus(): void;

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

void

smallScroll(options)

Прокручивает окно по указанному количеству строк. "Строка" соответствует прокручиваемому расстоянию, щелкнув стрелку прокрутки на полосе прокрутки один раз.

smallScroll(options?: Word.WindowScrollOptions): void;

Параметры

options: Word.WindowScrollOptions

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

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

void

toggleRibbon()

Отображает или скрывает ленту.

toggleRibbon(): void;

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

void

toJSON()

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

toJSON(): Word.Interfaces.WindowData;

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

Word.Interfaces.WindowData

track()

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

track(): Word.Window;

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

Word.Window

untrack()

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

untrack(): Word.Window;

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

Word.Window

Комментарии

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

Примеры

Свойства

Методы

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

activePane

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

Комментарии

Примеры

areRulersDisplayed

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

Комментарии

areScreenTipsDisplayed

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

Комментарии

areThumbnailsDisplayed

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

Комментарии

caption

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

Комментарии

context

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

height

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

Комментарии

horizontalPercentScrolled

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

Комментарии

imeMode

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

Комментарии

index

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

Комментарии

isActive

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

Комментарии

isDocumentMapVisible

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

Комментарии

isEnvelopeVisible

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

Комментарии

isHorizontalScrollBarDisplayed

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

Комментарии

isLeftScrollBarDisplayed

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

Комментарии

isRightRulerDisplayed

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

Комментарии

isSplit

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

Комментарии

isVerticalRulerDisplayed

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

Комментарии

isVerticalScrollBarDisplayed

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

Комментарии

isVisible

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

Комментарии

left

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

Комментарии

next

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

Комментарии

panes

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

Комментарии

Примеры

previous

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

Комментарии