OfficeScript package

Интерфейсы

OfficeScript.EmailAttachment	Вложение, отправляемые вместе с сообщением электронной почты. Значение должно быть указано по крайней мере для одного из toпараметров , ccили bcc . Если получатель не указан, отображается следующая ошибка: "В сообщении нет получателя. Введите значение по крайней мере для одного из параметров "to", "cc" или "bcc".
OfficeScript.FileProperties	Файл для скачивания.
OfficeScript.MailProperties	Свойства отправляемого сообщения электронной почты.

Перечисления

OfficeScript.EmailContentType	Тип контента. Возможные значения: text или HTML.
OfficeScript.EmailImportance	Значение важности сообщения электронной почты. Соответствует значениям важности "high", "normal" и "low", доступным в пользовательском интерфейсе Outlook.

Функции

OfficeScript.convertToPdf()	Преобразует документ в PDF-файл и возвращает его кодировку текста. Примечание. Последние изменения, внесенные в книгу в Excel в Интернете, с помощью сценариев Office или пользовательского интерфейса Excel, не могут быть записаны в PDF-файл.
OfficeScript.downloadFile(fileProperties)	Скачивает указанный файл в расположение загрузки по умолчанию, указанное локальным компьютером.
OfficeScript.Metadata.getScriptName()	Получите имя выполняемого в данный момент скрипта.
OfficeScript.saveCopyAs(filename)	Сохраняет копию текущей книги в OneDrive в том же каталоге, что и исходный файл, с указанным именем файла.
OfficeScript.sendMail(mailProperties)	Отправьте сообщение электронной почты с помощью скрипта Office. Используйте MailProperties для указания содержимого и получателей сообщения электронной почты.

Сведения о функции

OfficeScript.convertToPdf()

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Преобразует документ в PDF-файл и возвращает его кодировку текста. Примечание. Последние изменения, внесенные в книгу в Excel в Интернете, с помощью сценариев Office или пользовательского интерфейса Excel, не могут быть записаны в 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