Word.Application class

Pacote:

word

Representa o objeto do aplicativo.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApi 1.3 ]

Propriedades

context

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

Métodos

createDocument(base64File)	Cria um novo documento usando um arquivo de .docx com código Base64 opcional.
newObject(context)	Crie uma nova instância de Word. Objeto application
openDocument(filePath)	Abre um documento e o exibe em uma nova guia ou janela. Veja a seguir exemplos para os vários clientes e plataformas com suporte. Exemplo de localização remota ou na nuvem: https://microsoft.sharepoint.com/some/path/Document.docx Exemplos de localização local para Windows: C:\\Users\\Someone\\Documents\\Document.docx (inclui backslashes escapados necessários), file://mycomputer/myfolder/Document.docx Exemplo de local local para Mac e iOS: /User/someone/document.docx
retrieveStylesFromBase64(base64File)	Analisar estilos do arquivo Base64 do modelo e retornar o formato JSON de estilos recuperados como uma cadeia de caracteres.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o Word original. O objeto application é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.ApplicationData) que contém cópias rasas de todas as propriedades filho carregadas do objeto original.

Detalhes da propriedade

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

Detalhes do método

createDocument(base64File)

Cria um novo documento usando um arquivo de .docx com código Base64 opcional.

createDocument(base64File?: string): Word.DocumentCreated;

Parâmetros

base64File

string

Opcional. O arquivo .docx codificado em Base64. O valor padrão é nulo.

Retornos

Word.DocumentCreated

Comentários

[ Conjunto de API: WordApi 1.3 ]

Exemplos

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

// Updates the text of the current document with the text from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
  // Use the Base64-encoded string representation of the selected .docx file.
  const externalDoc = context.application.createDocument(externalDocument);
  await context.sync();

  const externalDocBody = externalDoc.body;
  externalDocBody.load("text");
  await context.sync();

  // Insert the external document's text at the beginning of the current document's body.
  const externalDocBodyText = externalDocBody.text;
  const currentDocBody = context.document.body;
  currentDocBody.insertText(externalDocBodyText, Word.InsertLocation.start);
  await context.sync();
});

newObject(context)

Crie uma nova instância de Word. Objeto application

static newObject(context: OfficeExtension.ClientRequestContext): Word.Application;

Parâmetros

context

OfficeExtension.ClientRequestContext

Retornos

Word.Application

openDocument(filePath)

Abre um documento e o exibe em uma nova guia ou janela. Veja a seguir exemplos para os vários clientes e plataformas com suporte.

• Exemplo de localização remota ou na nuvem: https://microsoft.sharepoint.com/some/path/Document.docx

• Exemplos de localização local para Windows: C:\\Users\\Someone\\Documents\\Document.docx (inclui backslashes escapados necessários), file://mycomputer/myfolder/Document.docx

• Exemplo de local local para Mac e iOS: /User/someone/document.docx

openDocument(filePath: string): void;

Parâmetros

filePath

string

Obrigatório. O caminho absoluto do arquivo .docx. Word na Web só dá suporte a locais remotos (nuvem), enquanto Word no Windows, no Mac e no iOS dão suporte a locais locais e remotos.

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.6 ]

retrieveStylesFromBase64(base64File)

Analisar estilos do arquivo Base64 do modelo e retornar o formato JSON de estilos recuperados como uma cadeia de caracteres.

retrieveStylesFromBase64(base64File: string): OfficeExtension.ClientResult<string>;

Parâmetros

base64File

string

Obrigatório. O arquivo de modelo.

Retornos

OfficeExtension.ClientResult<string>

Comentários

[ Conjunto de API: WordApi 1.5 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/get-external-styles.yaml

// Gets style info from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
  const retrievedStyles = context.application.retrieveStylesFromBase64(externalDocument);
  await context.sync();

  console.log("Styles from the other document:", retrievedStyles.value);
});

toJSON()

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

toJSON(): {
            [key: string]: string;
        };

Retornos

{ [key: string]: string; }