OfficeScript package

Schnittstellen

OfficeScript.DownloadFileProperties	Die datei, die heruntergeladen werden soll.
OfficeScript.EmailAttachment	Die Anlage, die mit der E-Mail gesendet werden soll. Ein Wert muss für mindestens einen der toParameter , ccoder bcc angegeben werden. Wenn kein Empfänger angegeben ist, wird der folgende Fehler angezeigt: "Die Nachricht hat keinen Empfänger. Geben Sie einen Wert für mindestens einen der Parameter "to", "cc" oder "bcc" ein.
OfficeScript.MailProperties	Die Eigenschaften der zu sendenden E-Mail.

Enumerationen

OfficeScript.EmailContentType	Der Typ des Inhalts. Mögliche Werte sind Text oder HTML.
OfficeScript.EmailImportance	Der Wichtigkeitswert der E-Mail. Entspricht den auf der Outlook-Benutzeroberfläche verfügbaren Werten für die Wichtigkeit "hoch", "normal" und "niedrig".

Functions

OfficeScript.convertToPdf()	Konvertiert das Dokument in eine PDF-Datei und gibt die Textcodierung zurück.
OfficeScript.downloadFile(fileProperties)	Lädt eine angegebene Datei an den vom lokalen Computer angegebenen Standarddownloadspeicherort herunter.
OfficeScript.Metadata.getScriptName()	Rufen Sie den Namen des derzeit ausgeführten Skripts ab.
OfficeScript.saveCopyAs(filename)	Speichert eine Kopie der aktuellen Arbeitsmappe in OneDrive im selben Verzeichnis wie die ursprüngliche Datei mit dem angegebenen Dateinamen. Diese API muss vor anderen APIs aufgerufen werden.
OfficeScript.sendMail(mailProperties)	Senden Sie eine E-Mail mit einem Office-Skript. Verwenden Sie MailProperties , um den Inhalt und die Empfänger der E-Mail anzugeben.

Details zur Funktion

OfficeScript.convertToPdf()

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

export function convertToPdf(): string;

Gibt zurück

string

Der Inhalt der Arbeitsmappe als Zeichenfolge im PDF-Format.

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

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

Throws: ExternalApiTimeout Wird ausgelöst, 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]
    })    
}

OfficeScript.downloadFile(fileProperties)

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

export function downloadFile(fileProperties: DownloadFileProperties): void;

Parameter

fileProperties

OfficeScript.DownloadFileProperties

Die datei, die heruntergeladen werden soll.

Throws: DownloadFileNameMissing Wird ausgelöst, wenn der Name leer ist.

Throws: DownloadFileContentMissing Wird ausgelöst, wenn der Inhalt leer ist.

Throws: DownloadFileInvalidExtension Wird ausgelöst, wenn die Dateinamenerweiterung nicht ".txt" oder ".pdf" lautet.

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

Gibt zurück

void

OfficeScript.Metadata.getScriptName()

Rufen Sie den Namen des derzeit ausgeführten Skripts ab.

export function getScriptName(): string;

Gibt zurück

string

OfficeScript.saveCopyAs(filename)

Speichert eine Kopie der aktuellen Arbeitsmappe in OneDrive im selben Verzeichnis wie die ursprüngliche Datei mit dem angegebenen Dateinamen. Diese API muss vor anderen APIs aufgerufen werden.

export function saveCopyAs(filename: string): void;

Parameter

filename

string

Der Dateiname der kopierten und gespeicherten Datei. Der Dateiname muss mit ".xlsx" enden.

Throws: SaveCopyAsInvalidExtension Wird ausgelöst, wenn der Dateiname nicht auf ".xlsx" endet.

Throws: SaveCopyAsMustBeCalledFirst Wird ausgelöst, wenn diese Methode nach anderen APIs aufgerufen wird.

Throws: SaveCopyAsFileMayAlreadyExist Wird ausgelöst, wenn der Dateiname der Kopie bereits vorhanden ist.

Throws: SaveCopyAsInvalidCharacters Wird ausgelöst, wenn der Dateiname ungültige Zeichen enthält.

Throws: SaveCopyAsFileNotOnOneDrive Wird ausgelöst, wenn das Dokument nicht auf OneDrive gespeichert wird.

Throws: ExternalApiTimeout Wird ausgelöst, wenn die API das Timeoutlimit von 30 Sekunden erreicht. Beachten Sie, dass die Kopie möglicherweise noch erstellt wird.

Gibt zurück

void

OfficeScript.sendMail(mailProperties)

Senden Sie eine E-Mail mit einem Office-Skript. Verwenden Sie MailProperties , um den Inhalt und die Empfänger der E-Mail anzugeben.

export function sendMail(mailProperties: MailProperties): void;

Parameter

mailProperties

OfficeScript.MailProperties

Gibt zurück

void