OfficeScript package

Converts the document to a PDF and returns the text encoding of it. Note: Recent changes made to the workbook in Excel on the web, through Office Scripts or the Excel UI, may not be captured in the PDF.

export function convertToPdf(): string;

Returns

The content of the workbook as a string, in PDF format.

Throws: ConvertToPdfEmptyWorkbook The error thrown if the document is empty.

Throws: ConvertToPdfProtectedWorkbook The error thrown if the document is protected.

Throws: ExternalApiTimeout The error thrown if the API reaches the timeout limit of 30 seconds.

Examples

/**
 * 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]
    })    
}

Downloads a specified file to the default download location specified by the local machine.

export function downloadFile(fileProperties: FileProperties): void;

Parameters

Returns

Get the name of the currently running script.

export function getScriptName(): string;

Returns

Saves a copy of the current workbook in OneDrive, in the same directory as the original file, with the specified file name.

export function saveCopyAs(filename: string): void;

Parameters

Returns

Send an email with an Office Script. Use MailProperties to specify the content and recipients of the email.

export function sendMail(mailProperties: MailProperties): void;

Parameters

Returns