OfficeScript package

Interfaces

OfficeScript.EmailAttachment	Pièce jointe à envoyer avec l’e-mail. Une valeur doit être spécifiée pour au moins l’un todes paramètres , ccou bcc . Si aucun destinataire n’est spécifié, l’erreur suivante s’affiche : « Le message n’a pas de destinataire. Entrez une valeur pour au moins l’un des paramètres « to », « cc » ou « bcc ».
OfficeScript.FileProperties	Fichier à télécharger.
OfficeScript.MailProperties	Propriétés de l’e-mail à envoyer.

Énumérations

OfficeScript.EmailContentType	Le type de contenu. Les valeurs possibles sont text ou HTML.
OfficeScript.EmailImportance	Valeur d’importance de l’e-mail. Correspond aux valeurs d’importance « haute », « normale » et « faible » disponibles dans l’interface utilisateur Outlook.

Functions

OfficeScript.convertToPdf()	Convertit le document au format PDF et retourne l’encodage de texte de celui-ci. Remarque : Les modifications récentes apportées au classeur dans Excel sur le Web, par le biais de scripts Office ou de l’interface utilisateur Excel, peuvent ne pas être capturées dans le fichier PDF.
OfficeScript.downloadFile(fileProperties)	Télécharge un fichier spécifié à l’emplacement de téléchargement par défaut spécifié par l’ordinateur local.
OfficeScript.Metadata.getScriptName()	Obtient le nom du script en cours d’exécution.
OfficeScript.saveCopyAs(filename)	Enregistre une copie du classeur actif dans OneDrive, dans le même répertoire que le fichier d’origine, avec le nom de fichier spécifié.
OfficeScript.sendMail(mailProperties)	Envoyer un e-mail avec un script Office. Utilisez MailProperties pour spécifier le contenu et les destinataires de l’e-mail.

Informations relatives à la fonction

OfficeScript.convertToPdf()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Convertit le document au format PDF et retourne l’encodage de texte de celui-ci. Remarque : Les modifications récentes apportées au classeur dans Excel sur le Web, par le biais de scripts Office ou de l’interface utilisateur Excel, peuvent ne pas être capturées dans le fichier PDF.

export function convertToPdf(): string;

Retours

string

Contenu du classeur sous forme de chaîne, au format PDF.

Lève : ConvertToPdfEmptyWorkbook erreur levée si le document est vide.

Throws : ConvertToPdfProtectedWorkbook erreur levée si le document est protégé.

Lève :ExternalApiTimeout erreur levée si l’API atteint la limite de délai d’expiration de 30 secondes.

Exemples

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

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Télécharge un fichier spécifié à l’emplacement de téléchargement par défaut spécifié par l’ordinateur local.

export function downloadFile(fileProperties: FileProperties): void;

Paramètres

fileProperties

OfficeScript.FileProperties

Fichier à télécharger.

Lève :DownloadFileNameMissing erreur levée si le nom est vide.

Lève :DownloadFileContentMissing erreur levée si le contenu est vide.

Lève : DownloadFileInvalidExtension erreur levée si l’extension de nom de fichier n’est pas « .txt » ou « .pdf ».

Lève :ExternalApiTimeout erreur levée si l’API atteint la limite de délai d’expiration de 30 secondes.

Retours

void

OfficeScript.Metadata.getScriptName()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient le nom du script en cours d’exécution.

export function getScriptName(): string;

Retours

string

OfficeScript.saveCopyAs(filename)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Enregistre une copie du classeur actif dans OneDrive, dans le même répertoire que le fichier d’origine, avec le nom de fichier spécifié.

export function saveCopyAs(filename: string): void;

Paramètres

filename

string

Nom du fichier copié et enregistré. Le nom de fichier doit se terminer par « .xlsx ».

Lève : InvalidExtensionError erreur levée si le nom de fichier ne se termine pas par « .xlsx ».

Lève : SaveCopyAsFileMayAlreadyExistError erreur levée si le nom de fichier de la copie existe déjà.

Lève :SaveCopyAsErrorInvalidCharacters erreur levée si le nom de fichier contient des caractères non valides.

Lève : SaveCopyAsFileNotOnOneDriveError erreur levée si le document n’est pas enregistré dans OneDrive.

Lève :ExternalApiTimeout erreur levée si l’API atteint la limite de délai d’expiration de 30 secondes. Notez que la copie peut toujours être créée.

Retours

void

OfficeScript.sendMail(mailProperties)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Envoyer un e-mail avec un script Office. Utilisez MailProperties pour spécifier le contenu et les destinataires de l’e-mail.

export function sendMail(mailProperties: MailProperties): void;

Paramètres

mailProperties

OfficeScript.MailProperties

Retours

void