OfficeScript package

Interfaces

OfficeScript.DownloadFileProperties	O ficheiro a transferir.
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.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.
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. Esta API tem de ser chamada antes de outras APIs.
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()

Converte o documento num PDF e devolve a codificação de texto do mesmo.

export function convertToPdf(): string;

Retornos

string

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

Lançamentos: ConvertToPdfEmptyWorkbook emitido se o documento estiver vazio.

Lançamentos: ConvertToPdfProtectedWorkbook emitido se o documento estiver protegido.

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

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

export function downloadFile(fileProperties: DownloadFileProperties): void;

Parâmetros

fileProperties

OfficeScript.DownloadFileProperties

O ficheiro a transferir.

Lançamentos: DownloadFileNameMissing emitido se o nome estiver vazio.

Lançamentos: DownloadFileContentMissing emitido se o conteúdo estiver vazio.

Emite: DownloadFileInvalidExtension é emitida se a extensão de nome de ficheiro não for ".txt" ou ".pdf".

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

Retornos

void

OfficeScript.Metadata.getScriptName()

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

export function getScriptName(): string;

Retornos

string

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. Esta API tem de ser chamada antes de outras APIs.

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".

Emite: SaveCopyAsInvalidExtension é emitido se o nome do ficheiro não terminar com ".xlsx".

Lançamentos: SaveCopyAsMustBeCalledFirst emitido se este método for chamado a seguir a outras APIs.

Emite: SaveCopyAsFileMayAlreadyExist é emitido se o nome do ficheiro da cópia já existir.

Emite: SaveCopyAsInvalidCharacters emitido se o nome do ficheiro contiver carateres inválidos.

Lançamentos: é SaveCopyAsFileNotOnOneDrive emitido se o documento não for guardado no OneDrive.

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

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