OfficeScript package

Interfaces

OfficeScript.EmailAttachment	O anexo a enviar com o e-mail. Tem de ser especificado um valor para, pelo menos, um dos toparâmetros , ccou bcc . Se não for especificado nenhum destinatário, é apresentado o seguinte erro: "A mensagem não tem destinatário. Introduza um valor para, pelo menos, um dos parâmetros "para", "cc" ou "bcc".
OfficeScript.FileProperties	O ficheiro a transferir.
OfficeScript.MailProperties	As propriedades do e-mail a enviar.

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 e-mail. Corresponde aos valores de importância "alta", "normal" e "baixa" disponíveis na IU do Outlook.

Funções

OfficeScript.convertToPdf()	Converte o documento num PDF e devolve a codificação de texto do mesmo. Nota: as alterações recentes efetuadas ao livro no Excel na Web, através dos Scripts do Office ou da IU do Excel, podem não ser capturadas no PDF.
OfficeScript.downloadFile(fileProperties)	Transfere um ficheiro especificado para a localização de transferência predefinida especificada pelo computador local.
OfficeScript.Metadata.getScriptName()	Obtenha o nome do script atualmente em execução.
OfficeScript.saveCopyAs(filename)	Guarda uma cópia do livro atual no OneDrive, no mesmo diretório do ficheiro original, com o nome de ficheiro especificado.
OfficeScript.sendMail(mailProperties)	Enviar um e-mail com um Script do Office. Utilize MailProperties para especificar o conteúdo e os destinatários do e-mail.

Detalhes da função

OfficeScript.convertToPdf()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Converte o documento num PDF e devolve a codificação de texto do mesmo. Nota: as alterações recentes efetuadas ao livro no Excel na Web, através dos Scripts do Office ou da IU do Excel, podem não ser capturadas no PDF.

export function convertToPdf(): string;

Retornos

string

O conteúdo do livro como uma cadeia, no formato PDF.

Emite: ConvertToPdfEmptyWorkbook o erro apresentado se o documento estiver vazio.

Emite: ConvertToPdfProtectedWorkbook o erro gerado se o documento estiver protegido.

Lançamentos: ExternalApiTimeout o erro 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)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Transfere um ficheiro especificado para a localização de transferência predefinida especificada pelo computador local.

export function downloadFile(fileProperties: FileProperties): void;

Parâmetros

fileProperties

OfficeScript.FileProperties

O ficheiro a transferir.

Gera: DownloadFileNameMissing o erro apresentado se o nome estiver vazio.

Gera: DownloadFileContentMissing o erro emitido se o conteúdo estiver vazio.

Gera: DownloadFileInvalidExtension o erro gerado se a extensão de nome de ficheiro não for ".txt" ou ".pdf".

Lançamentos: ExternalApiTimeout o erro gerado se a API atingir o limite de tempo limite de 30 segundos.

Retornos

void

OfficeScript.Metadata.getScriptName()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtenha o nome do script atualmente em execução.

export function getScriptName(): string;

Retornos

string

OfficeScript.saveCopyAs(filename)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Guarda uma cópia do livro atual no OneDrive, no mesmo diretório do ficheiro original, com o nome de ficheiro especificado.

export function saveCopyAs(filename: string): void;

Parâmetros

filename

string

O nome de ficheiro do ficheiro copiado e guardado. O nome do ficheiro tem de terminar com ".xlsx".

Gera: InvalidExtensionError o erro emitido se o nome do ficheiro não terminar com ".xlsx".

Gera: SaveCopyAsFileMayAlreadyExistError o erro gerado se o nome do ficheiro da cópia já existir.

Gera: SaveCopyAsErrorInvalidCharacters o erro emitido se o nome do ficheiro contiver carateres inválidos.

Gera: SaveCopyAsFileNotOnOneDriveError o erro gerado se o documento não for guardado no OneDrive.

Lançamentos: ExternalApiTimeout o erro gerado se a API atingir o limite de tempo limite de 30 segundos. Tenha em atenção que a cópia ainda pode ser criada.

Retornos

void

OfficeScript.sendMail(mailProperties)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Enviar um e-mail com um Script do Office. Utilize MailProperties para especificar o conteúdo e os destinatários do e-mail.

export function sendMail(mailProperties: MailProperties): void;

Parâmetros

mailProperties

OfficeScript.MailProperties

Retornos

void