OfficeScript package

接口

OfficeScript.EmailAttachment	要随电子邮件一起发送的附件。必须至少为、`cc` 或 `bcc` 参数之`to`一指定一个值。如果未指定收件人，则显示以下错误：“邮件没有收件人。请为至少一个“to”、“cc”或“bcc”参数输入值。
OfficeScript.FileProperties	要下载的文件。
OfficeScript.MailProperties	要发送的电子邮件的属性。

枚举

OfficeScript.EmailContentType	内容的类型。可能的值为 text 或 HTML。
OfficeScript.EmailImportance	电子邮件的重要性值。对应于 Outlook UI 中可用的“高”、“正常”和“低”重要性值。

函数

OfficeScript.convertToPdf()	将文档转换为 PDF 并返回其文本编码。注意：在 Excel web 版中，通过 Office 脚本或 Excel UI 对工作簿进行的最近更改可能无法在 PDF 中捕获。
OfficeScript.downloadFile(fileProperties)	将指定的文件下载到本地计算机指定的默认下载位置。
OfficeScript.Metadata.getScriptName()	获取当前正在运行的脚本的名称。
OfficeScript.saveCopyAs(filename)	使用指定的文件名将当前工作簿的副本保存在与原始文件相同的目录中的 OneDrive 中。
OfficeScript.sendMail(mailProperties)	使用 Office 脚本发送电子邮件。使用 `MailProperties` 指定电子邮件的内容和收件人。

函数详细信息

OfficeScript.convertToPdf()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

将文档转换为 PDF 并返回其文本编码。注意：在 Excel web 版中，通过 Office 脚本或 Excel UI 对工作簿进行的最近更改可能无法在 PDF 中捕获。

export function convertToPdf(): string;

string

工作簿的内容作为字符串，采用 PDF 格式。

引发： ConvertToPdfEmptyWorkbook 如果文档为空，则引发错误。

引发： ConvertToPdfProtectedWorkbook 如果文档受保护，则引发错误。

引发： ExternalApiTimeout 如果 API 达到 30 秒的超时限制，则引发错误。

示例

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

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

将指定的文件下载到本地计算机指定的默认下载位置。

export function downloadFile(fileProperties: FileProperties): void;

参数

fileProperties: OfficeScript.FileProperties

要下载的文件。

引发： DownloadFileNameMissing 如果名称为空，则引发错误。

引发： DownloadFileContentMissing 如果内容为空，则引发错误。

引发： DownloadFileInvalidExtension 如果文件扩展名不是“.txt”或“.pdf”，则引发错误。

引发： ExternalApiTimeout 如果 API 达到 30 秒的超时限制，则引发错误。

void

OfficeScript.Metadata.getScriptName()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取当前正在运行的脚本的名称。

export function getScriptName(): string;

string

OfficeScript.saveCopyAs(filename)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

使用指定的文件名将当前工作簿的副本保存在与原始文件相同的目录中的 OneDrive 中。

export function saveCopyAs(filename: string): void;

参数

filename: string

复制并保存的文件的文件名。文件名必须以“.xlsx”结尾。

引发： InvalidExtensionError 如果文件名不以“.xlsx”结尾，则引发错误。

引发： SaveCopyAsFileMayAlreadyExistError 如果副本的文件名已存在，则引发错误。

引发： SaveCopyAsErrorInvalidCharacters 如果文件名包含无效字符，则引发错误。

引发： SaveCopyAsFileNotOnOneDriveError 如果未将文档保存到 OneDrive，则引发错误。

引发： ExternalApiTimeout 如果 API 达到 30 秒的超时限制，则引发错误。请注意，仍可能创建副本。

void

OfficeScript.sendMail(mailProperties)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

使用 Office 脚本发送电子邮件。使用 MailProperties 指定电子邮件的内容和收件人。

export function sendMail(mailProperties: MailProperties): void;

参数

mailProperties: OfficeScript.MailProperties

void

反馈

此页面是否有帮助？