OfficeScript package
Interfaces
| OfficeScript.DownloadFileProperties |
Fichier à télécharger. |
| OfficeScript.EmailAttachment |
Pièce jointe à envoyer avec l’e-mail. Une valeur doit être spécifiée pour au moins l’un des |
| OfficeScript.MailProperties |
Les propriétés de l’e-mail à envoyer. |
Énumérations
| OfficeScript.EmailContentType |
Le type de contenu. Les valeurs possibles sont texte ou HTML. |
| OfficeScript.EmailImportance |
Valeur d’importance de l’e-mail. Correspond aux valeurs d’importance « élevée », « normale » et « faible » disponibles dans l’interface utilisateur d’Outlook. |
Functions
| Office |
Convertit le document au format PDF et renvoie le texte codé de celui-ci. |
| Office |
Téléchargé un fichier spécifié à l’emplacement de téléchargement par défaut spécifié par l’ordinateur local. |
| Office |
Obtenir le nom du script en cours d’exécution. |
| Office |
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é. Cette API doit être appelée avant les autres API. |
| Office |
Envoyez un e-mail avec un script Office. Permet |
Informations relatives à la fonction
OfficeScript.convertToPdf()
Convertit le document au format PDF et renvoie le texte codé de celui-ci.
export function convertToPdf(): string;Retours
string
Le contenu du classeur sous forme de chaîne, au format PDF.
Lève : ConvertToPdfEmptyWorkbook levé si le document est vide.
Throws : ConvertToPdfProtectedWorkbook levé si le document est protégé.
Lèvements : ExternalApiTimeout levés si l’API atteint le 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)
Téléchargé un fichier spécifié à l’emplacement de téléchargement par défaut spécifié par l’ordinateur local.
export function downloadFile(fileProperties: DownloadFileProperties): void;Paramètres
- fileProperties
- OfficeScript.DownloadFileProperties
Fichier à télécharger.
Throws : DownloadFileNameMissing Levé si le nom est vide.
Throws : DownloadFileContentMissing levé si le contenu est vide.
Lève : DownloadFileInvalidExtension levée si l’extension de nom de fichier n’est pas « .txt » ou « .pdf ».
Lèvements : ExternalApiTimeout levés si l’API atteint le délai d’expiration de 30 secondes.
Retours
void
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.
// 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()
Obtenir le nom du script en cours d’exécution.
export function getScriptName(): string;Retours
string
Exemples
/**
* 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)
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é. Cette API doit être appelée avant les autres API.
export function saveCopyAs(filename: string): void;Paramètres
- filename
-
string
Nom du fichier copié et enregistré. Le nom du fichier doit se terminer par « .xlsx ».
Lève : SaveCopyAsInvalidExtension levée si le nom de fichier ne se termine pas par « .xlsx ».
Throws : SaveCopyAsMustBeCalledFirst levé si cette méthode est appelée après d’autres API.
Throws : SaveCopyAsFileMayAlreadyExist levé si le nom de fichier de la copie existe déjà.
Lève : SaveCopyAsInvalidCharacters levée si le nom de fichier contient des caractères non valides.
Lève : SaveCopyAsFileNotOnOneDrive Levée si le document n’est pas enregistré dans OneDrive.
Lèvements : ExternalApiTimeout levés si l’API atteint le délai d’expiration de 30 secondes. Notez que la copie peut toujours être créée.
Retours
void
Exemples
/**
* 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)
Envoyez un e-mail avec un script Office. Permet MailProperties de spécifier le contenu et les destinataires de l’e-mail.
export function sendMail(mailProperties: MailProperties): void;Paramètres
- mailProperties
- OfficeScript.MailProperties
Retours
void
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]
})
}