Office.Addin interface

  • Référence
Paquet:
office

Représente les fonctionnalités de niveau complément pour l’exploitation ou la configuration de différents aspects du complément.

Remarques

Ensemble de conditions requises : SharedRuntime 1.1

Propriétés

beforeDocumentCloseNotification

Représente une boîte de dialogue de notification modale qui peut s’afficher lorsque l’utilisateur tente de fermer un document. Le document ne se ferme pas tant que l’utilisateur n’a pas répondu. Cette API est uniquement prise en charge dans Excel.

Méthodes

getStartupBehavior()

Obtient le comportement de démarrage actuel du complément.
hide()

Masque le volet Office.
onVisibilityModeChanged(handler)

Ajoute un gestionnaire pour l’événement onVisibilityModeChanged .
setStartupBehavior(behavior)

Définit le comportement de démarrage du complément pour la prochaine ouverture du document.
showAsTaskpane()

Affiche le volet Office associé au complément.

Détails de la propriété

beforeDocumentCloseNotification

Représente une boîte de dialogue de notification modale qui peut s’afficher lorsque l’utilisateur tente de fermer un document. Le document ne se ferme pas tant que l’utilisateur n’a pas répondu. Cette API est uniquement prise en charge dans Excel.

beforeDocumentCloseNotification: BeforeDocumentCloseNotification;

Valeur de propriété

Office.BeforeDocumentCloseNotification

Remarques

Ensemble de conditions requises : SharedRuntime 1.2

Détails de la méthode

getStartupBehavior()

Obtient le comportement de démarrage actuel du complément.

getStartupBehavior(): Promise<Office.StartupBehavior>;

Retours

Promise<Office.StartupBehavior>

Remarques

Ensemble de conditions requises : SharedRuntime 1.1

hide()

Masque le volet Office.

hide(): Promise<void>;

Retours

Promise<void>

Promesse résolue lorsque l’interface utilisateur est masquée.

Remarques

Ensemble de conditions requises : SharedRuntime 1.1

onVisibilityModeChanged(handler)

Ajoute un gestionnaire pour l’événement onVisibilityModeChanged .

onVisibilityModeChanged(
            handler: (message: VisibilityModeChangedMessage) => void,
        ): Promise<() => Promise<void>>;

Paramètres

handler

(message: Office.VisibilityModeChangedMessage) => void

Fonction de gestionnaire appelée lorsque l’événement est émis. Cette fonction accepte un message pour le composant de réception.

Retours

Promise<() => Promise<void>>

Promesse qui se résout en fonction lorsque le gestionnaire est ajouté. L’appel à cette méthode supprime le gestionnaire.

Remarques

Ensemble de conditions requises : SharedRuntime 1.1

Exemples

Office.onReady(() => {
    Office.addin.onVisibilityModeChanged((args) => {
        if (args.visibilityMode === Office.VisibilityMode.taskpane) {
            // Do something when the task pane is visible.
        }
    });

    // Other startup tasks.
});

setStartupBehavior(behavior)

Définit le comportement de démarrage du complément pour la prochaine ouverture du document.

setStartupBehavior(behavior: Office.StartupBehavior): Promise<void>;

Paramètres

behavior
Office.StartupBehavior

Spécifie le comportement de démarrage du complément.

Retours

Promise<void>

Remarques

Ensemble de conditions requises : SharedRuntime 1.1

Exemples

// Configure your add-in to load and start running when the document is opened.
Office.addin.setStartupBehavior(Office.StartupBehavior.load);

showAsTaskpane()

Affiche le volet Office associé au complément.

showAsTaskpane(): Promise<void>;

Retours

Promise<void>

Promesse résolue lorsque l’interface utilisateur est affichée.

Remarques

Ensemble de conditions requises : SharedRuntime 1.1