Word.Window class

Obtém o painel ativo na janela.

readonly activePane: Word.Pane;

Valor da propriedade

Comentários

[ Conjunto de API: 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}`);
  }
});

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

areRulersDisplayed: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se os comentários, notas de rodapé, notas de fim e hiperligações são apresentados como sugestões.

readonly areScreenTipsDisplayed: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

areThumbnailsDisplayed: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica a legenda texto da janela que é apresentada na barra de título do documento ou janela da aplicação.

caption: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Especifica a altura da janela (em pontos).

readonly height: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica a posição de deslocamento horizontal como uma percentagem da largura do documento.

horizontalPercentScrolled: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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 API: WordApiDesktop 1.4 ]

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

readonly index: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se a janela está ativa.

readonly isActive: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se o mapa do documento está visível.

isDocumentMapVisible: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se o cabeçalho da mensagem de e-mail está visível na janela do documento. O valor predefinido é false.

isEnvelopeVisible: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se é apresentada uma barra de deslocamento horizontal para a janela.

isHorizontalScrollBarDisplayed: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se a barra de deslocamento vertical aparece no lado esquerdo da janela do documento.

isLeftScrollBarDisplayed: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se a régua vertical aparece no lado direito da janela do documento na vista de esquema de impressão.

isRightRulerDisplayed: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

isSplit: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

isVerticalRulerDisplayed: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se é apresentada uma barra de deslocamento vertical para a janela.

isVerticalScrollBarDisplayed: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se a janela está visível.

isVisible: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly left: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém a janela do documento seguinte na coleção de janelas de documentos abertas.

readonly next: Word.Window;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly panes: Word.PaneCollection;

Valor da propriedade

Comentários

[ Conjunto de API: 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}`);
});

Obtém a janela do documento anterior nas janelas do documento aberto da coleção.

readonly previous: Word.Window;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica como o Microsoft Word apresenta os documentos de origem após um processo de comparação e intercalação.

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica a percentagem de divisão vertical da janela.

splitVertical: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Especifica a largura da área de estilo em pontos.

styleAreaWidth: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly top: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o tipo de janela.

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly usableHeight: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly usableWidth: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica a posição de deslocamento vertical como uma percentagem do comprimento do documento.

verticalPercentScrolled: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o View objeto que representa a vista da janela.

readonly view: Word.View;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica a largura da janela do documento, em pontos.

readonly width: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly windowNumber: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Ativa a janela.

activate(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Fecha a janela.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: 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);
});

Desloca a janela pelo número especificado de ecrãs.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

Retornos

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

Retornos

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

Retornos

Percorre a página da janela por página.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

Retornos

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

set(properties: Word.Window): void;

Parâmetros

Retornos

Define o foco da janela do documento para o corpo de uma mensagem de e-mail.

setFocus(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Desloca a janela pelo número especificado de linhas. Uma "linha" corresponde à distância percorrida ao clicar uma vez na seta de deslocamento na barra de deslocamento.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Exibe ou oculta a faixa

toggleRibbon(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.Window é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.WindowData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.WindowData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este 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, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

track(): Word.Window;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para 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. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Word.Window;

Retornos