Saltar al contenido principal
Docs
Ir al Studio
Roberty Studio
RPAOffice

Excel

Excel

IMPORTANTE

Para utilizar esta categoría es OBLIGATORIO tener instalado en tu computadora el paquete Office.

El módulo Excel es responsable de realizar acciones de manipulación de archivos de hojas de cálculo de Excel. Sus métodos pueden accederse conforme al ejemplo a continuación:

js
const excel = await Office.Excel.openWorkbook["v2_0_0"]({
  filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
});

Métodos​

openWorkbook​

Método responsable de abrir un archivo de Excel.

js
const workbook = await Office.Excel.openWorkbook["v2_0_0"]({
  filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
});

Parámetros obligatorios​

  • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

  • saveOnClose:Boolean - espera un valor booleano que indica si la hoja de cálculo será guardada después de cerrarse.
  • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo.
  • options:Object - espera un objeto para la configuración de apertura de la hoja de cálculo de Excel.
    • readOnly:Boolean - espera un valor booleano.
  • performanceMode:Boolean - espera un valor booleano que indica si la hoja de cálculo se abrirá en modo rendimiento. Valor predeterminado: false.

Retorno​

La constante o variable creada, como la workbook del ejemplo mostrado anteriormente, recibirá un objeto referente a la hoja de cálculo abierta (con las propiedades filePath, name, path, saveOnClose y performanceMode), que puede pasarse como parámetro workbook en las otras acciones de Excel.

createWorkbook​

Método responsable de crear un archivo de Excel.

js
await Office.Excel.createWorkbook["v1_0_0"]({
  name: "Planilha",
  workbook: {
    filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste2.xlsx",
  },
});

Parámetros obligatorios​

  • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
  • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

saveWorkbook​

Método responsable de guardar un archivo de Excel.

js
await Office.Excel.saveWorkbook["v1_0_0"]({
  workbook: {
    filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
  },
});

Parámetros obligatorios​

  • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

closeWorkbook​

Método responsable de cerrar un archivo de Excel.

js
await Office.Excel.closeWorkbook["v1_0_0"]({
  filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
});

Parámetros obligatorios​

  • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

createWorksheet​

Método responsable de crear una pestaña en un archivo de Excel.

js
await Office.Excel.createWorksheet["v1_0_0"]({
  workbook: {
    filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
  },
  name: "teste",
});

Parámetros obligatorios​

  • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
  • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable que reciba el retorno del método recibirá el objeto de la pestaña creada (con las propiedades name y workbook), que puede usarse en las otras acciones de Excel para indicar cuál es la pestaña destino.

renameWorksheet​

Método responsable de renombrar una pestaña de un archivo de Excel.

js
await Office.Excel.renameWorksheet["v1_0_0"]({
  newName: "teste2",
  worksheet: {
    name: "teste",
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  },
});

Parámetros obligatorios​

  • newName:String - espera un string con el nuevo nombre de la pestaña de la hoja de cálculo de Excel.
  • worksheet:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
    • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
      • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

selectWorksheet​

Método responsable de seleccionar una pestaña de un archivo de Excel.

js
const selectWorksheet = await Office.Excel.selectWorksheet["v1_0_0"]({
  name: `teste`,
  workbook: {
    filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
  },
});

Parámetros obligatorios​

  • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
  • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno, pero la constante creada como selectWorksheet puede usarse en las otras acciones de Excel para indicar cuál es la pestaña destino.

getTableValues​

Método responsable de obtener todos los valores de una tabla de una pestaña de Excel.

js
const getAllTableValues = await actions.Office.Excel.getTableValues["v1_0_1"]({
  name: `Table 1`,
  worksheet: {
    name: `teste`,
    workbook: {
      filePath: "C:\\Users\\igors\\Desktop\\teste.xlsx",
    },
  },
});

Parámetros obligatorios​

  • name:String - espera un string con el nombre de la tabla.
  • worksheet:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
    • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
      • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante getAllTableValues mostrada en el ejemplo anterior, devolverá el método values, que recibe una lista con los valores de la tabla.

js
actions.getAllTableValues.values;

getRawValuesFromWorksheet​

Método responsable de obtener todos los valores brutos de una pestaña de Excel.

js
const getRawValuesFromWorksheet = await Office.Excel.getRawValuesFromWorksheet["v1_0_0"]({
  worksheet: {
    name: "Plan1",
    workbook: {
      filePath: "C:\\Users\\Roberty\\Desktop\\teste.xlsx",
    },
  },
  ignoreEmptyRows: true,
});

Parámetros obligatorios​

  • worksheet:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
    • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
      • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.
  • ignoreEmptyRows:Boolean - espera un valor booleano que representa si se ignorarán o no las filas vacías.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante getRawValuesFromWorksheet mostrada en el ejemplo anterior, devolverá el método values, que recibe una lista con los valores de la tabla.

js
actions.getRawValuesFromWorksheet.values;

getAllValuesFromWorksheet​

Método responsable de obtener todos los valores de una pestaña de Excel.

js
const getAllCellValues = await Office.Excel.getAllValuesFromWorksheet["v1_0_0"](
  {
    name: `teste`,
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  }
);

Parámetros obligatorios​

  • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
  • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante getAllCellValues mostrada en el ejemplo anterior, devolverá el método values, que recibe una lista con los valores de la tabla.

js
actions.getAllCellValues.values;
actions.getAllCellValues.rowCount; // cantidad de filas
actions.getAllCellValues.columnCount; // cantidad de columnas

getAllWorksheetName​

Método responsable de obtener todos los nombres de pestañas de un archivo de Excel.

js
const getAllWorksheets = await Office.Excel.getAllWorksheetName["v1_0_0"]({
  filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
});

Parámetros obligatorios​

  • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante getAllWorksheets mostrada en el ejemplo anterior, recibirá un objeto con la propiedad worksheets, una lista con los nombres de las pestañas, y la propiedad count, la cantidad de pestañas.

js
actions.getAllWorksheets.worksheets;
actions.getAllWorksheets.count;

cloneWorksheet​

Método responsable de clonar una pestaña de un archivo de Excel.

js
await Office.Excel.cloneWorksheet["v1_0_0"]({
  worksheet: {
    name: `teste`,
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  },
  newName: `novaAba`,
});

Parámetros obligatorios​

  • newName:String - espera un string con el nuevo nombre de la pestaña de la hoja de cálculo de Excel.
  • worksheet:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
    • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
      • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

deleteWorksheet​

Método responsable de eliminar una pestaña de un archivo de Excel.

js
await Office.Excel.deleteWorksheet["v1_0_0"]({
  name: `novaAba`,
  workbook: {
    filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
  },
});

Parámetros obligatorios​

  • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
  • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

setCellValue​

Método responsable de definir un valor para una celda de un archivo de Excel.

js
await Office.Excel.setCellValue["v2_0_0"]({
  value: {
    value: `teste`,
  },
  cell: {
    position: {
      column: `A`,
      row: 1,
    },
    worksheet: {
      name: `teste`,
      workbook: {
        filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
      },
    },
  },
});

Parámetros obligatorios​

  • value:Object - espera un objeto referente al valor que será insertado en la celda.
    • value:Any - espera el valor que será insertado en la celda.
  • cell:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • position:Object - espera un objeto con la posición de la celda.
      • column:String - espera un string con la letra de la columna de la celda (ej.: A).
      • row:Number - espera un número con el índice de la fila de la celda.
    • worksheet:Object - espera un objeto referente a la hoja de cálculo de Excel.
      • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
      • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
        • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

  • value:Object - espera un objeto referente al valor que será insertado en la celda.
    • formula:String - espera un string con la fórmula que será insertada en la celda.
  • lastRowColumn: Boolean - espera un valor true o false; si es verdadero, siempre completará después de la última celda completada de la columna indicada por el usuario en el campo column.

Retorno​

Este método no tiene retorno.

setRowValues​

Método responsable de definir los valores de las celdas de una fila de un archivo de Excel.

js
await Office.Excel.setRowValues["v2_0_0"]({
  values: [{value: `teste-1`},{value: `teste-2`}],
  cell: {
    position: {
      column: `A`,
      row: 1,
    },
    worksheet: {
      name: `teste`,
      workbook: {
        filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
      },
    },
  }
});

Parámetros obligatorios​

  • values:Array - espera un array de objetos referente a los valores que serán insertados en cada celda de la fila. El objeto debe contener la propiedad a continuación:
    • value:String - espera un string con el valor que será insertado en la celda. Cabe destacar que también funciona con fórmulas.
  • cell:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • position:Object - espera un objeto referente a la información necesaria para el llenado de la fila.
      • column:String - espera un string con la letra de la columna donde comenzará el llenado.
      • row:Number - espera un número que representará la fila en la que comenzará el llenado.
    • worksheet:Object - espera un objeto referente a la hoja de cálculo de Excel.
      • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
      • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
        • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales:​

  • lastRow: Boolean - espera un valor true o false; si es verdadero, siempre completará después de la última fila completada de la hoja de cálculo.
  • lastRowColumn: Boolean - espera un valor true o false; si es verdadero, siempre completará después de la última fila completada referente a la COLUMNA indicada por el usuario en el campo column.

Retorno​

Este método no tiene retorno.

getCellValue​

Método responsable de obtener el valor de una celda de un archivo de Excel.

js
const getCellValue = await Office.Excel.getCellValue["v1_0_0"]({
  position: {
    column: `A`,
    row: 1,
  },
  worksheet: {
    name: `teste`,
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  },
});

Parámetros obligatorios​

  • position:Object - espera un objeto referente a la posición de la celda.
    • column:String - espera un string con el nombre de la columna deseada.
    • row:Number - espera un número referente al valor de la fila deseada.
  • worksheet:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
    • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
      • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante getCellValue mostrada en el ejemplo anterior, devolverá los métodos value y formula, que reciben el valor referente al valor en la celda.

js
actions.getCellValue.value;
actions.getCellValue.formula;

deleteColumn​

Método responsable de eliminar una columna de una pestaña de un archivo de Excel.

js
await Office.Excel.deleteColumn["v1_0_0"]({
  column: `A`,
  worksheet: {
    name: `teste`,
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  },
});

Parámetros obligatorios​

  • column:String - espera un string con el nombre de la columna deseada.
  • worksheet:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
    • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
      • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

deleteRow​

Método responsable de eliminar una fila de una pestaña de un archivo de Excel.

js
await Office.Excel.deleteRow["v1_0_0"]({
  row: 1,
  worksheet: {
    name: `teste`,
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  },
});

Parámetros obligatorios​

  • row:Number - espera un número referente al valor de la fila deseada.
  • worksheet:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
    • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
      • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

setCellStyle​

Acción responsable de crear un estilo de una celda de una hoja de cálculo de Excel.

js
await Office.Excel.setCellStyle["v1_0_0"]({
  cell: {
    position: {
      column: 'A',
      row: 1,
    },
    worksheet: {
      name: 'teste',
      workbook: {
        filePath: 'C:/Users/nome-de-usuario/Desktop/teste.xlsx',
      },
    },
  },
  color: '#0fd3b1',
  backgroundColor: '#473bfa',
  fontSize: 12,
  fontFamily: 'Arial',
});

Parámetros obligatorios​

  • cell:Object - espera un objeto referente a la celda que recibirá el estilo.
    • position:Object - espera un objeto con la posición de la celda.
      • column:String - espera un string con la letra de la columna de la celda (ej.: A).
      • row:Number - espera un número con el índice de la fila de la celda.
    • worksheet:Object - espera un objeto referente a la pestaña de la hoja de cálculo de Excel.
      • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
      • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
        • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

  • color:String - espera un string con el valor hexadecimal del color del texto de la celda.
  • backgroundColor:String - espera un string con el valor hexadecimal del color de fondo de la celda.
  • fontSize:Number - espera un número con el tamaño de la fuente de la celda.
  • fontFamily:String - espera un string con el nombre de la fuente de la celda (ej.: Arial).

Retorno​

Este método no tiene retorno.

setCellComment​

Acción responsable de crear un comentario en una hoja de cálculo de Excel.

js
await Office.Excel.setCellComment["v1_0_0"]({
  cell: {
    position: {
      column: 'A',
      row: 1,
    },
    worksheet: {
      name: 'teste',
      workbook: {
        filePath: 'C:/Users/nome-de-usuario/Desktop/teste.xlsx',
      },
    },
  },
  comment: 'teste',
});

Parámetros obligatorios​

  • comment:String - espera un string con el comentario que será insertado en la celda.
  • cell:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • position:Object - espera un objeto con la posición de la celda.
      • column:String - espera un string con la letra de la columna de la celda (ej.: A).
      • row:Number - espera un número con el índice de la fila de la celda.
    • worksheet:Object - espera un objeto referente a la hoja de cálculo de Excel.
      • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
      • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
        • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Retorno​

Este método no tiene retorno.

deleteCellComment​

Acción responsable de eliminar el comentario de una celda de un archivo de Excel.

js
await Office.Excel.deleteCellComment["v1_0_0"]({
  cell:{
    position: {
      column: 'A',
      row: 1,
    },
    worksheet: {
      name: `teste`,
      workbook: {
        filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
      },
    },
  }
});

Parámetros obligatorios​

  • cell:Object - espera un objeto referente a la celda cuyo comentario será eliminado.
    • position:Object - espera un objeto con la posición de la celda.
      • column:String - espera un string con el nombre de la columna (ej.: A, B, C).
      • row:Number - espera un número con el índice de la fila.
    • worksheet:Object - espera un objeto referente a la pestaña de la hoja de cálculo de Excel.
      • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
      • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
        • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Retorno​

Este método no tiene retorno.

addPicture​

Método responsable de agregar una imagen a una celda de un archivo de Excel.

js
await Office.Excel.addPicture["v1_0_0"]({
  cell: {
    position: {
      column: `A`,
      row: 1,
    },
    worksheet: {
      name: `teste`,
      workbook: {
        filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
      },
    },
  },
  name: `picture1`,
  path: `C:\\Users\\nome-de-usuario\\Desktop\\teste.png`,
});

Parámetros obligatorios​

  • cell:Object - espera un objeto referente a la posición de la celda.
    • position:Object - espera un objeto referente a la posición de la celda.
      • column:String - espera un string con el nombre de la columna deseada.
      • row:Number - espera un número referente al valor de la fila deseada.
    • worksheet:Object - espera un objeto referente a la hoja de cálculo de Excel.
      • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
      • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
        • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.
  • name:String - espera un string con el nombre deseado para la imagen.
  • path:String - espera un string con la ruta de la imagen que será insertada.

Parámetros opcionales​

  • percentSize:Number - espera un número referente al tamaño, en porcentaje, que tendrá la figura.

Retorno​

Este método no tiene retorno.

removeAllPictures​

Método responsable de eliminar todas las imágenes de una pestaña de un archivo de Excel.

js
await Office.Excel.removeAllPictures["v1_0_0"]({
  name: `teste`,
  workbook: {
    filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
  },
});

Parámetros obligatorios​

  • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
  • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

removePicture​

Método responsable de eliminar una imagen de una pestaña de un archivo de Excel.

js
await Office.Excel.removePicture["v1_0_0"]({
  name: `picture1`,
  worksheet: {
    name: `teste`,
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  },
});

Parámetros obligatorios​

  • name:String - espera un string con el nombre de la imagen que será eliminada de la hoja de cálculo de Excel.
  • worksheet:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
    • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
      • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

convertExcelToCSV​

Método responsable de convertir una pestaña de un archivo excel (.xlsx) en un csv separado por comas.

js
await Office.Excel.convertExcelToCSV["v1_0_0"]({
  workbook: workbook,
  saveFilePath: "C:\\Users\\nome-de-usuario\\Desktop\\arquivo.csv",
  sheetName: `Plan1`
});

Parámetros obligatorios​

  • workbook: Workbook object - espera un objeto de hoja de cálculo que puede obtenerse a través de la acción openWorkbook;
  • saveFilePath: String - espera una ruta donde será creado y guardado el archivo .csv;
  • sheetName: String - espera el nombre de la pestaña que ya existe en la hoja de cálculo y que será transformada en .csv.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

convertCSVToExcel​

Método responsable de convertir un archivo .csv en un archivo .xslx con una pestaña completada con la información del CSV. La pestaña creada tendrá el nombre predeterminado Plan1 en inglés o Planilha1 en portugués, según el idioma predeterminado de la máquina del usuario.

js
await Office.Excel.convertCSVToExcel["v1_0_0"]({
 csvPath: `C:\\Users\\Roberty\\Downloads\\arquivo.csv`,
  excelPath: `C:\\Users\\Roberty\\Downloads\\excel.xlsx`
});

Parámetros obligatorios​

  • csvPath: String - espera una ruta donde estará el archivo .csv que será convertido en una pestaña.
  • excelPath: String - espera la ruta donde será creado el archivo .xlsx.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

getRowValues​

Método responsable de obtener todos los valores de una fila de un archivo de Excel.

js
const rowData = await Office.Excel.getRowValues["v1_0_0"]({
  row: 1,
  worksheet: {
    name: "Plan1",
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  },
});

Parámetros obligatorios​

  • row:Number - espera un número con el índice de la fila cuyos valores serán obtenidos.
  • worksheet:Object - espera un objeto referente a la pestaña de la hoja de cálculo de Excel.
    • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
    • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
      • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada, como la rowData del ejemplo mostrado anteriormente, recibirá los valores de la fila especificada.

getRowCount​

Método responsable de obtener el total de filas completadas en una pestaña de un archivo de Excel.

js
const count = await Office.Excel.getRowCount["v1_0_0"]({
  worksheet: {
    name: "Plan1",
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  },
});

Parámetros obligatorios​

  • worksheet:Object - espera un objeto referente a la pestaña de la hoja de cálculo de Excel.
    • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
    • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
      • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada, como la count del ejemplo mostrado anteriormente, recibirá un número que representa el total de filas completadas en la pestaña.

sortByRow​

Método responsable de ordenar las filas de una pestaña de un archivo de Excel con base en una columna.

js
await Office.Excel.sortByRow["v1_0_0"]({
  column: "A",
  order: "ASC",
  worksheet: {
    name: "Plan1",
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  },
});

Parámetros obligatorios​

  • column:String - espera un string con el nombre de la columna que será usada como referencia para el ordenamiento.
  • worksheet:Object - espera un objeto referente a la pestaña de la hoja de cálculo de Excel.
    • name:String - espera un string con el nombre de la pestaña de la hoja de cálculo de Excel.
    • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
      • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel.

Parámetros opcionales​

  • ignoreFirstRow:Boolean - cuando es true, ignora la primera fila (encabezado) durante el ordenamiento. Valor predeterminado: true.
  • order:String - define la dirección del ordenamiento. Valor predeterminado: ASC. Los valores posibles son:
    • ASC: orden ascendente.
    • DESC: orden descendente.

Retorno​

Este método no tiene retorno.

runMacro​

Método responsable de ejecutar una macro de un archivo de Excel.

js
await Office.Excel.runMacro["v1_0_0"]({
  macro: "NomeDaMacro",
  workbook: {
    filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsm",
  },
});

Parámetros obligatorios​

  • macro:String - espera un string con el nombre de la macro que será ejecutada.
  • workbook:Object - espera un objeto referente a la hoja de cálculo de Excel.
    • filePath:String - espera un string con la ruta de la hoja de cálculo de Excel (debe ser un archivo .xlsm habilitado para macros).

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.