OfficeScript package

Interfaces

OfficeScript.EmailAttachment	Datos adjuntos que se van a enviar con el correo electrónico. Se debe especificar un valor para al menos uno de los toparámetros , cco bcc . Si no se especifica ningún destinatario, se muestra el siguiente error: "El mensaje no tiene ningún destinatario. Escriba un valor para al menos uno de los parámetros "to", "cc" o "bcc".
OfficeScript.FileProperties	Archivo que se va a descargar.
OfficeScript.MailProperties	Propiedades del correo electrónico que se va a enviar.

Enumeraciones

OfficeScript.EmailContentType	Tipo de contenido. Los valores posibles son text o HTML.
OfficeScript.EmailImportance	Valor de importancia del correo electrónico. Corresponde a los valores de importancia "high", "normal" y "low" disponibles en la interfaz de usuario de Outlook.

Funciones

OfficeScript.convertToPdf()	Convierte el documento en un PDF y devuelve la codificación de texto del mismo. Nota: Es posible que los cambios recientes realizados en el libro en Excel en la Web, a través de scripts de Office o la interfaz de usuario de Excel, no se capturen en el PDF.
OfficeScript.downloadFile(fileProperties)	Descarga un archivo especificado en la ubicación de descarga predeterminada especificada por el equipo local.
OfficeScript.Metadata.getScriptName()	Obtenga el nombre del script que se está ejecutando actualmente.
OfficeScript.saveCopyAs(filename)	Guarda una copia del libro actual en OneDrive, en el mismo directorio que el archivo original, con el nombre de archivo especificado.
OfficeScript.sendMail(mailProperties)	Enviar un correo electrónico con un script de Office. Use MailProperties para especificar el contenido y los destinatarios del correo electrónico.

Detalles de la función

OfficeScript.convertToPdf()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Convierte el documento en un PDF y devuelve la codificación de texto del mismo. Nota: Es posible que los cambios recientes realizados en el libro en Excel en la Web, a través de scripts de Office o la interfaz de usuario de Excel, no se capturen en el PDF.

export function convertToPdf(): string;

Devoluciones

string

El contenido del libro como una cadena, en formato PDF.

Produce: ConvertToPdfEmptyWorkbook el error que se produce si el documento está vacío.

Produce: ConvertToPdfProtectedWorkbook el error que se produce si el documento está protegido.

Se produce el ExternalApiTimeout error si la API alcanza el límite de tiempo de espera de 30 segundos.

Ejemplos

/**
 * This script saves a worksheet as a PDF and emails that PDF to a recipient.
 */
function main(workbook: ExcelScript.Workbook) {    
    // Create the PDF.
    const pdfObject = OfficeScript.convertToPdf();
    const pdfFile = { name: "report.pdf", content: pdfObject }; // Enter your desired PDF name here.

    // Email the PDF.
    OfficeScript.sendMail({
        to: "name@email.com", // Enter your recipient email address here.
        subject: "[Demo] Monthly Sales Report", // This is the subject of your email.
        content: "Here's the Monthly Sales Report", // This is the content within your email.
        attachments: [pdfFile]
    })    
}

OfficeScript.downloadFile(fileProperties)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Descarga un archivo especificado en la ubicación de descarga predeterminada especificada por el equipo local.

export function downloadFile(fileProperties: FileProperties): void;

Parámetros

fileProperties

OfficeScript.FileProperties

Archivo que se va a descargar.

Produce: DownloadFileNameMissing error que se produce si el nombre está vacío.

Produce: DownloadFileContentMissing error que se produce si el contenido está vacío.

Se produce el DownloadFileInvalidExtension error si la extensión de nombre de archivo no es ".txt" o ".pdf".

Se produce el ExternalApiTimeout error si la API alcanza el límite de tiempo de espera de 30 segundos.

Devoluciones

void

OfficeScript.Metadata.getScriptName()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtenga el nombre del script que se está ejecutando actualmente.

export function getScriptName(): string;

Devoluciones

string

OfficeScript.saveCopyAs(filename)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Guarda una copia del libro actual en OneDrive, en el mismo directorio que el archivo original, con el nombre de archivo especificado.

export function saveCopyAs(filename: string): void;

Parámetros

filename

string

Nombre de archivo del archivo copiado y guardado. El nombre de archivo debe terminar con ".xlsx".

Se produce el InvalidExtensionError error si el nombre de archivo no termina con ".xlsx".

Se produce el SaveCopyAsFileMayAlreadyExistError error si el nombre de archivo de la copia ya existe.

Produce: SaveCopyAsErrorInvalidCharacters error que se produce si el nombre de archivo contiene caracteres no válidos.

Produce: SaveCopyAsFileNotOnOneDriveError el error que se produce si el documento no se guarda en OneDrive.

Se produce el ExternalApiTimeout error si la API alcanza el límite de tiempo de espera de 30 segundos. Tenga en cuenta que es posible que se siga creando la copia.

Devoluciones

void

OfficeScript.sendMail(mailProperties)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Enviar un correo electrónico con un script de Office. Use MailProperties para especificar el contenido y los destinatarios del correo electrónico.

export function sendMail(mailProperties: MailProperties): void;

Parámetros

mailProperties

OfficeScript.MailProperties

Devoluciones

void