Word.Application class

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Crea un nuevo documento mediante un archivo .docx codificado en Base64 opcional.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Ejemplos

// 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: Word.DocumentCreated = context.application.createDocument(externalDocument);
  await context.sync();

  if (!Office.context.requirements.isSetSupported("WordApiHiddenDocument", "1.3")) {
    console.warn("The WordApiHiddenDocument 1.3 requirement set isn't supported on this client so can't proceed. Try this action on a platform that supports this requirement set.");
    return;
  }

  const externalDocBody: Word.Body = 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: Word.Body = context.document.body;
  currentDocBody.insertText(externalDocBodyText, Word.InsertLocation.start);
  await context.sync();
});

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Word.Interfaces.ApplicationLoadOptions): Word.Application;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Cree una nueva instancia del Word.Application objeto .

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

Parámetros

Devoluciones

Abre un documento y lo muestra en una nueva pestaña o ventana. A continuación se muestran ejemplos de los distintos clientes y plataformas admitidos.

• Ejemplo de ubicación remota o en la nube: https://microsoft.sharepoint.com/some/path/Document.docx

• Ejemplos de ubicación local para Windows: C:\\Users\\Someone\\Documents\\Document.docx (incluye barras diagonales inversas con escape necesarias), file://mycomputer/myfolder/Document.docx

• Ejemplo de ubicación local para Mac e iOS: /User/someone/document.docx

openDocument(filePath: string): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.6 ]

Analice los estilos del archivo Base64 de plantilla y devuelva el formato JSON de los estilos recuperados como una cadena.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.5 ]

Ejemplos

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

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

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

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Word.Application): void;

Parámetros

Devoluciones

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.Application es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.ApplicationData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Word.Interfaces.ApplicationData;

Devoluciones