Partager via

Office.GetSelectedDataOptions interface

Paquet:
office

Fournit des options de personnalisation des données retournées et de leur mise en forme.

Remarques

Exemples

/* Set the selection options. These will:
 - Pass the string "myContext" to the callback.
 - Include both visible and hidden data.
 - Return the formatted values of the selection 
     (for an Excel date, 1/1/2023 instead of 44928).
 */  
const options: Office.GetSelectedDataOptions = {
    asyncContext: "myContext",
    filterType: Office.FilterType.All,
    valueFormat: Office.ValueFormat.Formatted
}

// Get the selected data in the Office document as text.
Office.context.document.getSelectedDataAsync(
    Office.CoercionType.Text,
    options,
    (asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.error(`${asyncResult.asyncContext}: asyncResult.error.message`);
        } else {
            console.log(`The selected data is "${asyncResult.value}".`);
        }
});

Propriétés

asyncContext

Élément défini par l’utilisateur de tout type retourné, inchangé, dans la propriété asyncContext de l’objet AsyncResult passé à un rappel.
filterType

Spécifiez s’il faut obtenir uniquement les données visibles (c’est-à-dire filtrées dans) ou toutes les données. Utile lors du filtrage des données. Utilisez Office.FilterType ou string équivalent. Ce paramètre est ignoré dans les documents Word.
valueFormat

Spécifiez si les données sont mises en forme. Utilisez Office.ValueFormat ou string équivalent.

Détails de la propriété

asyncContext

Élément défini par l’utilisateur de tout type retourné, inchangé, dans la propriété asyncContext de l’objet AsyncResult passé à un rappel.

asyncContext?: any

Valeur de propriété

any

filterType

Spécifiez s’il faut obtenir uniquement les données visibles (c’est-à-dire filtrées dans) ou toutes les données. Utile lors du filtrage des données. Utilisez Office.FilterType ou string équivalent. Ce paramètre est ignoré dans les documents Word.

filterType?: Office.FilterType | string

Valeur de propriété

Office.FilterType | string

valueFormat

Spécifiez si les données sont mises en forme. Utilisez Office.ValueFormat ou string équivalent.

valueFormat?: Office.ValueFormat | string

Valeur de propriété

Office.ValueFormat | string