OfficeScript package

インターフェイス

OfficeScript.DownloadFileProperties	ダウンロードするファイル。
OfficeScript.EmailAttachment	電子メールで送信する添付ファイル。 to 、cc、または bcc パラメーターの少なくとも 1 つに値を指定する必要があります。 受信者が指定されていない場合は、次のエラーが表示されます。 少なくとも 1 つの "to"、"cc"、または "bcc" パラメーターの値を入力してください。
OfficeScript.MailProperties	送信する電子メールのプロパティ。

列挙型

OfficeScript.EmailContentType	コンテンツの種類。 指定できる値はテキストまたは HTML です。
OfficeScript.EmailImportance	電子メールの重要度の値。 Outlook UI で使用できる "高"、"標準"、および "低" の重要度の値に対応します。

関数

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" で終わらない場合にスローされます。

Throws: 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