OfficeScript package

Interfaces

OfficeScript.DownloadFileProperties	O arquivo a ser baixado.
OfficeScript.EmailAttachment	O anexo para enviar com o email. Um valor deve ser especificado para pelo menos um dos toparâmetros , cc, ou bcc . Se nenhum destinatário for especificado, o seguinte erro será mostrado: "A mensagem não tem destinatário. Insira um valor para pelo menos um dos parâmetros "to", "cc" ou "bcc".
OfficeScript.MailProperties	As propriedades do email a ser enviado.

Enumerações

OfficeScript.EmailContentType	O tipo de conteúdo. Os valores possíveis são texto ou HTML.
OfficeScript.EmailImportance	O valor de importância do email. Corresponde aos valores de importância "alta", "normal" e "baixa" disponíveis na interface do usuário do Outlook.

Funções

OfficeScript.convertToPdf()	converte o documento em um PDF e retorna a codificação de texto dele.
OfficeScript.downloadFile(fileProperties)	Baixa um arquivo especificado para o local de download padrão especificado pelo computador local.
OfficeScript.Metadata.getScriptName()	Obtenha o nome do script em execução no momento.
OfficeScript.saveCopyAs(filename)	Salva uma cópia da pasta de trabalho atual no OneDrive, no mesmo diretório do arquivo original, com o nome de arquivo especificado. Essa API deve ser chamada antes de outras APIs.
OfficeScript.sendMail(mailProperties)	Envie um email com um script do Office. Use MailProperties para especificar o conteúdo e os destinatários do email.

Detalhes da função

OfficeScript.convertToPdf()

converte o documento em um PDF e retorna a codificação de texto dele.

export function convertToPdf(): string;

Retornos

string

O conteúdo da pasta de trabalho como uma cadeia de caracteres, no formato PDF.

Throws: ConvertToPdfEmptyWorkbook Lançado se o documento estiver vazio.

Throws: ConvertToPdfProtectedWorkbook Lançado se o documento estiver protegido.

Throws: ExternalApiTimeout Gerado se a API atingir o limite de tempo limite de 30 segundos.

Exemplos

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

Baixa um arquivo especificado para o local de download padrão especificado pelo computador local.

export function downloadFile(fileProperties: DownloadFileProperties): void;

Parâmetros

fileProperties

OfficeScript.DownloadFileProperties

O arquivo a ser baixado.

Throws: DownloadFileNameMissing Throw se o nome estiver vazio.

Throws: DownloadFileContentMissing Throw se o conteúdo estiver vazio.

Throws: DownloadFileInvalidExtension Lançado se a extensão do nome do arquivo não for ".txt" ou ".pdf".

Throws: ExternalApiTimeout Gerado se a API atingir o limite de tempo limite de 30 segundos.

Retornos

void

Exemplos

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

Obtenha o nome do script em execução no momento.

export function getScriptName(): string;

Retornos

string

Exemplos

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

Salva uma cópia da pasta de trabalho atual no OneDrive, no mesmo diretório do arquivo original, com o nome de arquivo especificado. Essa API deve ser chamada antes de outras APIs.

export function saveCopyAs(filename: string): void;

Parâmetros

filename

string

O nome do arquivo copiado e salvo. O nome do arquivo deve terminar com ".xlsx".

Throws: SaveCopyAsInvalidExtension Gerado se o nome do arquivo não terminar com ".xlsx".

Throws: SaveCopyAsMustBeCalledFirst Gerado se este método for chamado após outras APIs.

Throws: SaveCopyAsFileMayAlreadyExist Lançado se o nome do arquivo da cópia já existir.

Throws: SaveCopyAsInvalidCharacters Lançado se o nome do arquivo contiver caracteres inválidos.

Throws: SaveCopyAsFileNotOnOneDrive Throw se o documento não for salvo no OneDrive.

Throws: ExternalApiTimeout Gerado se a API atingir o limite de tempo limite de 30 segundos. Observe que a cópia ainda pode ser criada.

Retornos

void

Exemplos

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

Envie um email com um script do Office. Use MailProperties para especificar o conteúdo e os destinatários do email.

export function sendMail(mailProperties: MailProperties): void;

Parâmetros

mailProperties

OfficeScript.MailProperties

Retornos

void

Exemplos

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