OfficeScript package

Konvertiert das Dokument in eine PDF-Datei und gibt die Textcodierung zurück.

export function convertToPdf(): string;

Gibt zurück

Der Inhalt der Arbeitsmappe als Zeichenfolge im PDF-Format.

Throws: ConvertToPdfEmptyWorkbook Wird ausgelöst, wenn das Dokument leer ist.

Throws: Wird ausgelöst, ConvertToPdfProtectedWorkbook wenn das Dokument geschützt ist.

Throws: Wird ausgelöst, ExternalApiTimeout wenn die API das Timeoutlimit von 30 Sekunden erreicht.

Beispiele

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

Lädt eine angegebene Datei an den vom lokalen Computer angegebenen Standarddownloadspeicherort herunter.

export function downloadFile(fileProperties: DownloadFileProperties): void;

Parameter

Gibt zurück

Beispiele

/**
 * 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.

    // Download the PDF.
    OfficeScript.downloadFile(pdfFile);

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

Ruft den Namen des aktuell ausgeführten Skripts ab.

export function getScriptName(): string;

Gibt zurück

Beispiele

/**
 * This script gets the name of the current script and prints it to the console.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the name of the currently running script.
  const scriptName = OfficeScript.Metadata.getScriptName();
  console.log("The currently running script is: " + scriptName);

Speichert eine Kopie der aktuellen Arbeitsmappe in OneDrive im selben Verzeichnis wie die Originaldatei unter dem angegebenen Dateinamen. Diese API muss vor anderen APIs aufgerufen werden.

export function saveCopyAs(filename: string): void;

Parameter

Gibt zurück

Beispiele

/**
 * This script saves a copy of the current workbook to the user's OneDrive.
 */
function main(workbook: ExcelScript.Workbook) {    
    OfficeScript.saveCopyAs("CopyOfBook2.xlsx"); 
}

Senden einer E-Mail mit einem Office-Skript. Wird MailProperties verwendet, um den Inhalt und die Empfänger der E-Mail anzugeben.

export function sendMail(mailProperties: MailProperties): void;

Parameter

Gibt zurück

Beispiele

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