Word.Application class

Paquete:

word

Representa el objeto de aplicación.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Propiedades

context

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

Métodos

createDocument(base64File)	Crea un nuevo documento mediante un archivo .docx codificado en Base64 opcional.
newObject(context)	Cree una nueva instancia de Word. Application (objeto)
openDocument(filePath)	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
retrieveStylesFromBase64(base64File)	Analice los estilos del archivo Base64 de plantilla y devuelva el formato JSON de los estilos recuperados como una cadena.
toJSON()	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 Word original. El objeto 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.

Detalles de las propiedades

context

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

Word.RequestContext

Detalles del método

createDocument(base64File)

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

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

Parámetros

base64File

string

Opcional. El archivo .docx codificado en Base64. El valor predeterminado es null.

Devoluciones

Word.DocumentCreated

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

Cree una nueva instancia de Word. Application (objeto)

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

Parámetros

context

OfficeExtension.ClientRequestContext

Devoluciones

Word.Application

openDocument(filePath)

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

filePath

string

Obligatorio. Ruta de acceso absoluta del archivo .docx. Word en la web solo admite ubicaciones remotas (en la nube), mientras que Word en Windows, Mac y iOS admiten ubicaciones locales y remotas.

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.6 ]

retrieveStylesFromBase64(base64File)

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

base64File

string

Obligatorio. El archivo de plantilla.

Devoluciones

OfficeExtension.ClientResult<string>

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

toJSON()

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 Word original. El objeto 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(): {
            [key: string]: string;
        };

Devoluciones

{ [key: string]: string; }