Partager via

Office.CoercionType enum

  • Référence
Paquet:
office

Indique comment forcer le type des données retournées ou définies par la méthode appelée.

Remarques

La prise en charge des applications et des plateformes pour chacune CoercionType d’elles est spécifiée dans les descriptions des ensembles de conditions requises suivantes.

Exemples

// This function displays the currently selected text in the console.
// It uses the Common APIs.
function run() {
    Office.context.document.getSelectedDataAsync(Office.CoercionType.Text, (asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.error(asyncResult.error.message);
        } else {
            console.log(`The selected data is "${asyncResult.value}".`);
        }
    });
}

Champs

Html

Renvoyer ou définir des données au format HTML.

Remarque : s’applique uniquement aux données dans les compléments pour Word et les compléments Outlook pour Outlook (mode de composition).
Image

Les données sont renvoyées ou définies sous la forme d’un flux d’images. Remarque : s’applique uniquement aux données dans Excel, Word et PowerPoint.
Matrix

Renvoyer ou définir des données sous forme de données tabulaires sans en-tête. Les données sont renvoyées ou définies sous forme d’un tableau de tableaux contenant des suites de caractères à une dimension. Par exemple, trois lignes de valeurs de chaîne dans deux colonnes seraient : [["R1C1 », « R1C2"], ["R2C1 », « R2C2"], ["R3C1 », « R3C2"]].

Remarque : s’applique uniquement aux données dans Excel et Word.
Ooxml

Renvoyer ou définir des données au format Office Open XML.

Remarque : s’applique uniquement aux données dans Word.
SlideRange

Retourne un objet JSON qui contient un tableau des ID, titres et index des diapositives sélectionnées. Par exemple, {"slides":[{"id":257,"title":"Slide 2","index":2},{"id":256,"title":"Slide 1","index":1}]} pour une sélection de deux diapositives.

Remarque : s’applique uniquement aux données dans PowerPoint lors de l’appel de la méthode Document.getSelectedData pour obtenir la diapositive actuelle ou la plage de diapositives sélectionnée.
Table

Renvoyer ou définir des données sous forme de données tabulaires avec en-têtes facultatifs. Les données sont renvoyées ou définies sous la forme d’un tableau de tableaux avec des en-têtes facultatifs.

Remarque : s’applique uniquement aux données dans Excel et Word.
Text

Retourne ou définit des données sous forme de texte (chaîne). Les données sont retournées ou définies sous forme de suite unidimensionnelle de caractères.
XmlSvg

Les données sont retournées ou définies en tant que données XML contenant une image SVG. Remarque : s’applique uniquement aux données dans Excel, Word et PowerPoint.