Word.Window class

Representa a janela que exibe o documento. Uma janela pode ser dividida para conter vários painéis de leitura.

Comentários

Usada por

Exemplos

// 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);
  }
});

Propriedades

activePane	Obtém o painel ativo na janela.
areRulersDisplayed	Especifica se as réguas são exibidas para a janela ou painel.
areScreenTipsDisplayed	Especifica se comentários, notas de rodapé, notas de fim e hiperlinks são exibidos como dicas.
areThumbnailsDisplayed	Especifica se imagens em miniatura das páginas em um documento são exibidas no lado esquerdo da janela do documento do Microsoft Word.
caption	Especifica o texto da legenda da janela que é exibida na barra de título da janela do documento ou aplicativo.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
height	Especifica a altura da janela (em pontos).
horizontalPercentScrolled	Especifica a posição de rolagem horizontal como uma porcentagem da largura do documento.
imeMode	Especifica o modo de inicialização padrão para o IME (editor de método de entrada) japonês.
index	Obtém a posição de um item em uma coleção.
isActive	Especifica se a janela está ativa.
isDocumentMapVisible	Especifica se o mapa do documento é visível.
isEnvelopeVisible	Especifica se o cabeçalho da mensagem de email está visível na janela do documento. O valor padrão é `false`.
isHorizontalScrollBarDisplayed	Especifica se uma barra de rolagem horizontal é exibida para a janela.
isLeftScrollBarDisplayed	Especifica se a barra de rolagem vertical é exibida no lado esquerdo da janela do documento.
isRightRulerDisplayed	Especifica se a régua vertical aparece no lado direito da janela do documento no modo de exibição de layout de impressão.
isSplit	Especifica se a janela está dividida em vários painéis.
isVerticalRulerDisplayed	Especifica se uma régua vertical é exibida para a janela ou painel.
isVerticalScrollBarDisplayed	Especifica se uma barra de rolagem vertical é exibida para a janela.
isVisible	Especifica se a janela está visível.
left	Especifica a posição horizontal da janela, medida em pontos.
next	Obtém a próxima janela de documento na coleção de janelas de documento abertas.
panes	Obtém a coleção de painéis na janela.
previous	Obtém a janela do documento anterior nas janelas do documento aberto da coleção.
showSourceDocuments	Especifica como o Microsoft Word exibe documentos de origem após um processo de comparação e mesclagem.
splitVertical	Especifica a porcentagem de divisão vertical da janela.
state	Especifica o estado da janela do documento ou da janela de tarefa.
styleAreaWidth	Especifica a largura da área de estilo em pontos.
top	Especifica a posição vertical da janela do documento, em pontos.
type	Obtém o tipo de janela.
usableHeight	Obtém a altura (em pontos) da área de trabalho ativa na janela do documento.
usableWidth	Obtém a largura (em pontos) da área de trabalho ativa na janela do documento.
verticalPercentScrolled	Especifica a posição de rolagem vertical como uma porcentagem do comprimento do documento.
view	Obtém o `View` objeto que representa a exibição da janela.
width	Especifica a largura da janela do documento, em pontos.
windowNumber	Obtém um número inteiro que representa a posição da janela.

Métodos

activate()	Ativa a janela.
close(options)	Fecha a janela.
largeScroll(options)	Rola a janela pelo número especificado de telas.
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
pageScroll(options)	Percorre a janela página por página.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
setFocus()	Define o foco da janela do documento para o corpo de uma mensagem de email.
smallScroll(options)	Rola a janela pelo número especificado de linhas. Uma "linha" corresponde à distância rolada clicando na seta de rolagem na barra de rolagem uma vez.
toggleRibbon()	Exibe ou oculta a faixa
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é passado para `JSON.stringify()`. (`JSON.stringify`, por sua vez, chama o `toJSON` método do objeto que é passado para ele.) Enquanto o objeto original `Word.Window` é um objeto de API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `Word.Interfaces.WindowData`) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
track()	Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre `.sync` chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará ligar `context.sync()` antes que a liberação de memória entre em vigor.

activePane

Obtém o painel ativo na janela.

readonly activePane: Word.Pane;

Valor da propriedade

Word.Pane

Comentários

Conjunto de APIs: WordApiDesktop 1.2

Exemplos

// 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

Especifica se as réguas são exibidas para a janela ou painel.

areRulersDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areScreenTipsDisplayed

Especifica se comentários, notas de rodapé, notas de fim e hiperlinks são exibidos como dicas.

readonly areScreenTipsDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

areThumbnailsDisplayed

Especifica se imagens em miniatura das páginas em um documento são exibidas no lado esquerdo da janela do documento do Microsoft Word.

areThumbnailsDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

caption

Especifica o texto da legenda da janela que é exibida na barra de título da janela do documento ou aplicativo.

caption: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: WordApiDesktop 1.4

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

height

Especifica a altura da janela (em pontos).

readonly height: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

horizontalPercentScrolled

Especifica a posição de rolagem horizontal como uma porcentagem da largura do documento.

horizontalPercentScrolled: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

imeMode

Especifica o modo de inicialização padrão para o IME (editor de método de entrada) japonês.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.4

index

Obtém a posição de um item em uma coleção.

readonly index: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isActive

Especifica se a janela está ativa.

readonly isActive: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isDocumentMapVisible

Especifica se o mapa do documento é visível.

isDocumentMapVisible: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isEnvelopeVisible

Especifica se o cabeçalho da mensagem de email está visível na janela do documento. O valor padrão é false.

isEnvelopeVisible: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isHorizontalScrollBarDisplayed

Especifica se uma barra de rolagem horizontal é exibida para a janela.

isHorizontalScrollBarDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isLeftScrollBarDisplayed

Especifica se a barra de rolagem vertical é exibida no lado esquerdo da janela do documento.

isLeftScrollBarDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isRightRulerDisplayed

Especifica se a régua vertical aparece no lado direito da janela do documento no modo de exibição de layout de impressão.

isRightRulerDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isSplit

Especifica se a janela está dividida em vários painéis.

isSplit: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isVerticalRulerDisplayed

Especifica se uma régua vertical é exibida para a janela ou painel.

isVerticalRulerDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isVerticalScrollBarDisplayed

Especifica se uma barra de rolagem vertical é exibida para a janela.

isVerticalScrollBarDisplayed: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

isVisible

Especifica se a janela está visível.

isVisible: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

left

Especifica a posição horizontal da janela, medida em pontos.

readonly left: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

panes

Obtém a coleção de painéis na janela.

readonly panes: Word.PaneCollection;

Valor da propriedade

Word.PaneCollection

Comentários

Conjunto de APIs: WordApiDesktop 1.2

Exemplos

// 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

Especifica como o Microsoft Word exibe documentos de origem após um processo de comparação e mesclagem.

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

Valor da propriedade

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

Comentários

Conjunto de APIs: WordApiDesktop 1.4

splitVertical

Especifica a porcentagem de divisão vertical da janela.

splitVertical: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

state

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica o estado da janela do documento ou da janela de tarefa.

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

Valor da propriedade

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

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

styleAreaWidth

Especifica a largura da área de estilo em pontos.

styleAreaWidth: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

top

Especifica a posição vertical da janela do documento, em pontos.

readonly top: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

type

Obtém o tipo de janela.

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

Valor da propriedade

Word.WindowType | "Document" | "Template"

Comentários

Conjunto de APIs: WordApiDesktop 1.4

usableHeight

Obtém a altura (em pontos) da área de trabalho ativa na janela do documento.

readonly usableHeight: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

usableWidth

Obtém a largura (em pontos) da área de trabalho ativa na janela do documento.

readonly usableWidth: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

verticalPercentScrolled

Especifica a posição de rolagem vertical como uma porcentagem do comprimento do documento.

verticalPercentScrolled: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

view

Obtém o View objeto que representa a exibição da janela.

readonly view: Word.View;

Valor da propriedade

Word.View

Comentários

Conjunto de APIs: WordApiDesktop 1.4

width

Especifica a largura da janela do documento, em pontos.

readonly width: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

windowNumber

Obtém um número inteiro que representa a posição da janela.

readonly windowNumber: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

activate()

Ativa a janela.

activate(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

close(options)

Fecha a janela.

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

Parâmetros

options: Word.WindowCloseOptions

Opcional. As opções que definem se as alterações devem ser salvas antes do fechamento e se o documento deve ser roteado.

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Exemplos

// 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)

Rola a janela pelo número especificado de telas.

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

Parâmetros

options: Word.WindowScrollOptions

Opcional. As opções para rolar a janela pelo número especificado de telas. Se nenhuma opção for especificada, a janela rolará uma tela para baixo.

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

options: Word.Interfaces.WindowLoadOptions

Fornece opções para quais propriedades do objeto devem ser carregadas.

Retornos

Word.Window

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames: string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.

Retornos

Word.Window

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

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

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.

Retornos

Word.Window

pageScroll(options)

Percorre a janela página por página.

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

Parâmetros

options: Word.WindowPageScrollOptions

Opcional. As opções para rolar pela janela página por página.

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties: Word.Interfaces.WindowUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options: OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Word.Window): void;

Parâmetros

properties: Word.Window

Retornos

void

setFocus()

Define o foco da janela do documento para o corpo de uma mensagem de email.

setFocus(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

smallScroll(options)

Rola a janela pelo número especificado de linhas. Uma "linha" corresponde à distância rolada clicando na seta de rolagem na barra de rolagem uma vez.

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

Parâmetros

options: Word.WindowScrollOptions

Opcional. As opções para rolar a janela pelo número especificado de linhas. Se nenhuma opção for especificada, a janela será rolada uma linha para baixo.

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

toggleRibbon()

Exibe ou oculta a faixa

toggleRibbon(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Word.Window é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.WindowData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.WindowData;

Retornos

Word.Interfaces.WindowData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.Window;

Retornos

Word.Window

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): Word.Window;

Retornos

Word.Window

Comentários

Usada por

Exemplos

Propriedades

Métodos

Detalhes da propriedade

activePane

Valor da propriedade

Comentários

Exemplos

areRulersDisplayed

Valor da propriedade

Comentários

areScreenTipsDisplayed

Valor da propriedade

Comentários

areThumbnailsDisplayed

Valor da propriedade

Comentários

caption

Valor da propriedade

Comentários

context

Valor da propriedade

height

Valor da propriedade

Comentários

horizontalPercentScrolled

Valor da propriedade

Comentários

imeMode

Valor da propriedade

Comentários

index

Valor da propriedade

Comentários

isActive

Valor da propriedade

Comentários

isDocumentMapVisible

Valor da propriedade

Comentários

isEnvelopeVisible

Valor da propriedade

Comentários

isHorizontalScrollBarDisplayed

Valor da propriedade

Comentários

isLeftScrollBarDisplayed

Valor da propriedade

Comentários

isRightRulerDisplayed

Valor da propriedade

Comentários

isSplit

Valor da propriedade

Comentários

isVerticalRulerDisplayed

Valor da propriedade

Comentários

isVerticalScrollBarDisplayed

Valor da propriedade

Comentários

isVisible

Valor da propriedade

Comentários

left

Valor da propriedade

Comentários

next

Valor da propriedade

Comentários

panes

Valor da propriedade

Comentários

Exemplos

previous

Valor da propriedade

Comentários