OfficeScript package

Интерфейсы

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

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

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

Функции

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

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

OfficeScript.convertToPdf()

Преобразует документ в 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)

Скачивает указанный файл в расположение загрузки по умолчанию, указанное локальным компьютером.

export function downloadFile(fileProperties: DownloadFileProperties): void;

Параметры

fileProperties

OfficeScript.DownloadFileProperties

Файл для скачивания.

Вызывается: DownloadFileNameMissing вызывается, если имя пустое.

Выдает: DownloadFileContentMissing вызывается, если содержимое пусто.

Вызывается: DownloadFileInvalidExtension возникает, если расширение имени файла не является ".txt" или ".pdf".

Вызывается: ExternalApiTimeout возникает, если API достигает предельного времени ожидания в 30 секунд.

Возвращаемое значение

void

OfficeScript.Metadata.getScriptName()

Получите имя выполняемого в данный момент скрипта.

export function getScriptName(): string;

Возвращаемое значение

string

OfficeScript.saveCopyAs(filename)

Сохраняет копию текущей книги в OneDrive в том же каталоге, что и исходный файл, с указанным именем файла. Этот API должен вызываться перед другими API.

export function saveCopyAs(filename: string): void;

Параметры

filename

string

Имя скопированного и сохраненного файла. Имя файла должно заканчиваться на ".xlsx".

Вызывается, SaveCopyAsInvalidExtension если имя файла не заканчивается на ".xlsx".

Вызывается, SaveCopyAsMustBeCalledFirst если этот метод вызывается после других API.

Вызывается: SaveCopyAsFileMayAlreadyExist вызывается, если имя файла копии уже существует.

Вызывается: SaveCopyAsInvalidCharacters возникает, если имя файла содержит недопустимые символы.

Вызывается: SaveCopyAsFileNotOnOneDrive возникает, если документ не сохранен в OneDrive.

Вызывается: ExternalApiTimeout возникает, если API достигает предельного времени ожидания в 30 секунд. Обратите внимание, что копия по-прежнему может быть создана.

Возвращаемое значение

void

OfficeScript.sendMail(mailProperties)

Отправьте сообщение электронной почты с помощью скрипта Office. Используйте MailProperties для указания содержимого и получателей сообщения электронной почты.

export function sendMail(mailProperties: MailProperties): void;

Параметры

mailProperties

OfficeScript.MailProperties

Возвращаемое значение

void