OfficeScript package

ドキュメントを PDF に変換し、そのテキスト エンコーディングを返します。

export function convertToPdf(): 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]
    })    
}

指定したファイルを、ローカル コンピューターで指定された既定のダウンロード場所にダウンロードします。

export function downloadFile(fileProperties: DownloadFileProperties): 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]
    })    
}

現在実行中のスクリプトの名前を取得します。

export function getScriptName(): 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);

OneDrive 内の現在のブックのコピーを、指定されたファイル名で元のファイルと同じディレクトリに保存します。 この API は、他の API の前に呼び出す必要があります。

export function saveCopyAs(filename: string): void;

パラメーター

返品

例

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

Office スクリプトを使用してメールを送信します。 MailProperties を使用して、メールの内容と受信者を指定します。

export function sendMail(mailProperties: 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]
    })
 }