OfficeScript package

Интерфейсы

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

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

OfficeScript.EmailContentType	Тип контента. Возможные значения: текст или HTML.
OfficeScript.EmailImportance	Значение важности сообщения электронной почты. Соответствует значениям важности "высокая", "нормальная" и "низкая", доступным в пользовательском интерфейсе 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.

Throws: выбрасывается, ConvertToPdfEmptyWorkbook если документ пустой.

Throws: Throws, ConvertToPdfProtectedWorkbook если документ защищен.

Throws: запускается, 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

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

Throws: Throws, DownloadFileNameMissing если имя пусто.

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

Throws: выбрасывается, DownloadFileInvalidExtension если расширение имени файла отличается от ".txt" или ".pdf".

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

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

void

Примеры

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

OfficeScript.Metadata.getScriptName()

Получить имя выполняемого сценария.

export function getScriptName(): string;

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

string

Примеры

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

OfficeScript.saveCopyAs(filename)

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

export function saveCopyAs(filename: string): void;

Параметры

filename: string

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

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

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

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

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

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

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

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

void

Примеры

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

OfficeScript.sendMail(mailProperties)

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

export function sendMail(mailProperties: MailProperties): void;

Параметры

mailProperties: OfficeScript.MailProperties

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

void

Примеры

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

Обратная связь

Были ли сведения на этой странице полезными?