RPAOffice

Word

Word

El módulo Word es responsable de realizar acciones de manipulación de archivos creados en Word. Sus métodos pueden accederse conforme al ejemplo a continuación:

js

const fillError = await Office.Word.fillWordTemplate["v2_0_0"]({
  outputPath: "C:/Users/Roberty/Documents/",
  fileName: "teste.docx",
  templatePath: "C:/Users/Roberty/Documents/testeTemplate.docx",
  data: {
    name: "Roberty",
    phone: "123-456-7890",
    email: "roberty@roberty.app"
  }
})

Métodos

fillWordTemplate

Método responsable de completar las variables de una plantilla dinámica de Word.

js

const fillError = await Office.Word.fillWordTemplate["v2_0_0"]({
  outputPath: "C:/Users/Roberty/Documents/",
  fileName: "teste.docx",
  templatePath: "C:/Users/Roberty/Documents/testeTemplate.docx",
  data: {
    name: "Roberty",
    phone: "123-456-7890",
    email: "roberty@roberty.app"
    }
  }) 

Parámetros obligatorios

• outputPath: String - espera la ruta de la carpeta donde se guardará el archivo completado.
• fileName: String - espera el nombre (con extensión) del archivo que será generado. Si ya existe un archivo con ese nombre en la carpeta, el método devuelve el error outputAlreadyExists.
• templatePath: String - espera la ruta de la plantilla que será completada. La ruta debe contener el nombre del archivo y la extensión.

Parámetros opcionales

• data: Object - espera un objeto con las variables que serán completadas en la plantilla. Las claves del objeto deben ser los nombres de las variables de la plantilla definidas entre llaves dobles (ej.: {{name}}).

Retorno

La constante o variable creada, como la fillError del ejemplo mostrado anteriormente, recibirá un valor del tipo Objeto que dará acceso a las siguientes propiedades:

• fillError.error: String - devuelve un mensaje de error si el llenado no se realiza con éxito (ej.: templateNotFound cuando no se encuentra el template, outputAlreadyExists cuando el archivo de salida ya existe). Cuando el llenado se realiza con éxito, el objeto devuelto está vacío.