office package

Klassen

Office.TableData	Stellt die Daten in einer Tabelle oder einer Office.TableBinding-Datei dar.
OfficeExtension.ClientObject	Ein abstraktes Proxyobjekt, das ein Objekt in einem Office-Dokument darstellt. Sie erstellen Proxyobjekte aus dem Kontext (oder aus anderen Proxyobjekten), fügen einer Warteschlange Befehle hinzu, um auf das Objekt zu reagieren, und synchronisieren dann den Proxyobjektstatus mit dem Dokument, indem `context.sync()`Sie .
OfficeExtension.ClientRequestContext	Ein abstraktes RequestContext-Objekt, das Anforderungen an die Office-Anwendung erleichtert. Die `Excel.run` und-Methode `Word.run` stellt einen Anforderungskontext bereit.
OfficeExtension.ClientResult	Enthält das Ergebnis für Methoden, die primitive Typen zurückgeben. Die Value-Eigenschaft des Objekts wird nach `context.sync()` dem Aufruf aus dem Dokument abgerufen.
OfficeExtension.EmbeddedSession	Stellt eine Sitzung eines Visio-Diagramms dar, das in eine SharePoint-Seite eingebettet ist. Weitere Informationen finden Sie unter Übersicht über die Visio-JavaScript-API.
OfficeExtension.Error	Das Fehlerobjekt, das von zurückgegeben wird `context.sync()`, wenn eine Zusage aufgrund eines Fehlers bei der Verarbeitung der Anforderung abgelehnt wird.
OfficeExtension.ErrorCodes	Stellt den Fehlercode dar, der von OfficeExtension.Error.code zurückgegeben werden kann. Weitere Informationen zu den Fehlercodes finden Sie unter Häufige API-Fehlercodes für Office.
OfficeExtension.EventHandlerResult	Ermöglicht das Entfernen eines Ereignishandlers. Von der `EventHandlers.add` Methode zurückgegeben. Hinweis: Beim Entfernen des Handlers muss dasselbe RequestContext-Objekt verwendet werden, in dem der Handler hinzugefügt wurde. Weitere Informationen finden Sie unter Entfernen eines Ereignishandlers.
OfficeExtension.EventHandlers
OfficeExtension.TrackedObjects	Sammlung von verfolgten Objekten, die in einem Anforderungskontext enthalten sind. Weitere Informationen finden Sie unter context.trackedObjects .

Schnittstellen

Office.Actions	Verwaltet Aktionen und Tastenkombinationen.
Office.AddBindingFromNamedItemOptions	Bietet Optionen zum Konfigurieren der erstellten Bindung.
Office.AddBindingFromPromptOptions	Bietet Optionen zum Konfigurieren der Eingabeaufforderung und zum Identifizieren der erstellten Bindung.
Office.AddBindingFromSelectionOptions	Bietet Optionen zum Identifizieren der erstellten Bindung.
Office.Addin	Stellt Funktionen auf Add-In-Ebene zum Betreiben oder Konfigurieren verschiedener Aspekte des Add-Ins dar.
Office.AddinCommands.Event	Das `Event` Objekt wird als Parameter an Add-In-Funktionen übergeben, die von Funktionsbefehlsschaltflächen aufgerufen werden. Das Objekt ermöglicht es dem Add-In zu erkennen, auf welche Schaltfläche geklickt wurde, und der Office-Anwendung zu signalisieren, dass die Verarbeitung abgeschlossen ist.
Office.AddinCommands.EventCompletedOptions	Gibt das Verhalten eines On-Send-Add-Ins, eines Onlinebesprechungsanbieters oder eines mobilen Add-Ins zur Notizprotokollierung an, wenn die Verarbeitung eines Ereignisses in Outlook abgeschlossen ist.
Office.AddinCommands.Source	Kapselt Quelldaten für Add-In-Ereignisse.
Office.AsyncContextOptions	Bietet eine Option zum unveränderten Beibehalten von Kontextdaten beliebigen Typs zur Verwendung in einem Rückruf.
Office.AsyncResult	Ein Objekt, das das Ergebnis einer asynchronen Anforderung kapselt, einschließlich Status- und Fehlerinformationen, falls bei der Anforderung ein Fehler aufgetreten ist. Wenn die Funktion, die Sie an den `callback` Parameter einer "Async"-Methode übergeben, ausgeführt wird, empfängt sie ein AsyncResult-Objekt, auf das Sie über den einzigen Parameter der `callback` Funktion zugreifen können.
Office.Auth	Der Office-Authentifizierungsnamespace , stellt Methoden für die Office-Clientanwendung bereit, `Office.auth`um Zugriffstoken auf die Webanwendung des Add-Ins abzurufen. Dadurch kann das Add-In indirekt auch auf die Microsoft Graph-Daten des angemeldeten Benutzers zugreifen, ohne dass sich der Benutzer ein zweites Mal anmelden muss.
Office.AuthContext	Stellt die Benutzerinformationen dar, die an die Microsoft Authentication Library für JavaScript (MSAL.js) übergeben werden können.
Office.AuthOptions	Stellt Optionen für die Benutzererfahrung bereit, wenn Office ein Zugriffstoken für das Add-In von AAD Version 2.0 mit der `getAccessToken` Methode abruft.
Office.BeforeDocumentCloseNotification	Stellt ein modales Benachrichtigungsdialogfeld dar, das angezeigt werden kann, wenn der Benutzer versucht, ein Dokument zu schließen. Das Dokument wird erst geschlossen, wenn der Benutzer antwortet. Im Benachrichtigungsdialogfeld kann der Benutzer die Anforderung zum Schließen des Dokuments bestätigen oder die Anforderung zum Schließen des Dokuments abbrechen. Diese API wird nur in Excel unterstützt.
Office.Binding	Stellt eine Bindung an einen Abschnitt des Dokuments dar. Das Binding-Objekt macht die Funktionalität aller Bindungen unabhängig vom Typ verfügbar. Das Binding-Objekt wird nie direkt aufgerufen. Es handelt sich um die abstrakte übergeordnete Klasse der Objekte, die die einzelnen Bindungstypen darstellen: Office.MatrixBinding, Office.TableBinding oder Office.TextBinding. Alle drei Objekte erben die getDataAsync- und setDataAsync-Methoden vom Binding-Objekt, die Ihnen die Interaktion mit den Daten in der Bindung ermöglichen. Sie erben auch die ID- und Typeigenschaften zum Abfragen dieser Eigenschaftswerte. Darüber hinaus stellen die MatrixBinding- und TableBinding-Objekte zusätzliche Methoden für matrix- und tabellenspezifische Funktionen zur Verfügung, z. B. das Zählen der Anzahl von Zeilen und Spalten.
Office.BindingDataChangedEventArgs	Stellt Informationen zu der Bindung bereit, die das DataChanged-Ereignis ausgelöst hat.
Office.Bindings	Stellt die Bindungen des Add-Ins innerhalb des Dokuments dar.
Office.BindingSelectionChangedEventArgs	Stellt Informationen zu der Bindung bereit, die das SelectionChanged-Ereignis ausgelöst hat.
Office.Context	Stellt die Laufzeitumgebung des Add-Ins dar und stellt den Zugriff auf Schlüsselobjekte der API bereit. Der aktuelle Kontext existiert als Eigenschaft von Office. Der Zugriff erfolgt über `Office.context`.
Office.ContextInformation	Enthält Informationen zur Umgebung, in der das Add-In ausgeführt wird.
Office.ContextMenu	Bietet Optionen zum Verwalten des Status des Office-Kontextmenüs. Weitere Informationen finden Sie unter Ändern der Verfügbarkeit von Add-In-Befehlen.
Office.ContextMenuControl	Stellt ein einzelnes Kontextmenü-Steuerelement und dessen Status dar. Weitere Informationen finden Sie unter Ändern der Verfügbarkeit von Add-In-Befehlen.
Office.ContextMenuUpdaterData	Stellt die Änderungen am Kontextmenü dar. Weitere Informationen finden Sie unter Ändern der Verfügbarkeit von Add-In-Befehlen.
Office.Control	Stellt ein einzelnes Steuerelement oder einen Befehl und dessen Status dar.
Office.CustomXmlNode	Stellt einen XML-Knoten in einer Struktur in einem Dokument dar.
Office.CustomXmlPart	Stellt ein einzelnes CustomXMLPart in einer Office.CustomXmlParts-Auflistung dar.
Office.CustomXmlParts	Stellt eine Auflistung von CustomXmlPart-Objekten dar.
Office.CustomXmlPrefixMappings	Stellt eine Auflistung von CustomXmlPart-Objekten dar.
Office.DevicePermission	Stellt Methoden für ein Add-In bereit, um von einem Benutzer die Berechtigung zum Zugriff auf seine Gerätefunktionen anzufordern. Zu den Gerätefunktionen eines Benutzers gehören seine Kamera, Geolokalisierung und sein Mikrofon.
Office.Dialog	Das Objekt, das zurückgegeben wird, wenn `UI.displayDialogAsync` es aufgerufen wird. Es macht Methoden zum Registrieren von Ereignishandlern und zum Schließen des Dialogfelds verfügbar.
Office.DialogMessageOptions	Bietet Optionen für das Senden von Nachrichten in beide Richtungen zwischen einem Dialogfeld und seinem übergeordneten Dialogfeld.
Office.DialogOptions	Stellt Optionen für die Anzeige eines Dialogfelds bereit.
Office.DialogParentMessageReceivedEventArgs	Enthält Informationen zur Nachricht von der übergeordneten Seite, die das `DialogParentMessageReceived` Ereignis ausgelöst hat. Verwenden Sie zum Hinzufügen eines Ereignishandlers für das `DialogParentMessageReceived` Ereignis die `addHandlerAsync` Methode des Office.UI-Objekts .
Office.Document	Eine abstrakte Klasse, die das Dokument darstellt, mit dem das Add-In interagiert.
Office.DocumentSelectionChangedEventArgs	Stellt Informationen zu dem Dokument bereit, das das SelectionChanged-Ereignis ausgelöst hat.
Office.Error	Stellt spezifische Informationen zu einem Fehler bereit, der bei einem asynchronen Datenvorgang aufgetreten ist.
Office.ExtensionLifeCycle	Stellen Sie Optionen zum Verwalten der Benutzeroberfläche eines Office-Add-Ins bereit, während das Add-In ausgeführt wird.
Office.File	Stellt die einem Office Add-In zugeordnete Dokumentdatei dar.
Office.FileProperties
Office.GetBindingDataOptions	Bietet Optionen zum Abrufen der Daten in einer Bindung.
Office.GetFileOptions	Bietet Optionen zum Festlegen der Größe der Segmente, in die das Dokument unterteilt wird.
Office.GetSelectedDataOptions	Bietet Optionen zum Anpassen, welche Daten zurückgegeben und wie sie formatiert werden.
Office.GoToByIdOptions	Bietet Optionen dafür, ob der Speicherort ausgewählt werden soll, zu dem navigiert wird.
Office.Group	Stellt eine Gruppe von Steuerelementen auf einer Registerkarte des Menübands dar. Anforderungssatz: RibbonApi 1.1
Office.IPromiseConstructor
Office.MatrixBinding	Stellt eine Bindung in zwei Dimensionen von Zeilen und Spalten dar.
Office.NodeDeletedEventArgs	Stellt Informationen zu dem gelöschten Knoten bereit, der das nodeDeleted-Ereignis ausgelöst hat.
Office.NodeInsertedEventArgs	Stellt Informationen zu dem eingefügten Knoten bereit, der das nodeInserted-Ereignis ausgelöst hat.
Office.NodeReplacedEventArgs	Stellt Informationen zu dem ersetzten Knoten bereit, der das nodeReplaced-Ereignis ausgelöst hat.
Office.OfficeTheme	Bietet Zugriff auf die Eigenschaften für Office-Farbdesigns. Durch die Verwendung von Office-Designfarben können Sie das Farbschema Ihres Add-Ins mit dem aktuellen vom Benutzer ausgewählten Office-Design koordinieren. Der Benutzer legt in einer Office-Anwendung ein Design über das>Dateikonto oder dasOffice-Konto-Office-Design> fest. Das ausgewählte Design wird dann auf alle Office-Anwendungen angewendet. Using Office theme colors is appropriate for mail and task pane add-ins. Weitere Informationen zu Office-Designs finden Sie unter Ändern des Aussehens und Verhaltens von Microsoft 365.
Office.OnReadyOptions	Stellt Optionen für das `onReady` Ereignis bereit.
Office.RangeCoordinates	Gibt eine Zelle, Zeile oder Spalte anhand ihrer nullbasierten Zeilen- und/oder Spaltennummer an. Beispiel: `{row: 3, column: 4}` Gibt die Zelle in der dritten (nullbasierten) Zeile in der 4. Spalte (nullbasiert) an.
Office.RangeFormatConfiguration	Gibt einen Bereich und dessen Formatierung an.
Office.RemoveHandlerOptions	Bietet Optionen zum Bestimmen, welche(r) Ereignishandler/-handler entfernt werden.
Office.RequirementSetSupport	Enthält Informationen darüber, welche Anforderungssätze in der aktuellen Umgebung unterstützt werden.
Office.Ribbon	Eine Schnittstelle, die alle Funktionen enthält, die zum Verwalten des Status des Office-Menübands bereitgestellt werden.
Office.RibbonUpdaterData	Gibt Änderungen am Menüband an, z. B. den aktivierten oder deaktivierten Status einer Schaltfläche.
Office.SaveSettingsOptions	Bietet Optionen zum Speichern von Einstellungen.
Office.SetBindingDataOptions	Bietet Optionen zum Festlegen der Daten in einer Bindung.
Office.SetSelectedDataOptions	Bietet Optionen zum Einfügen von Daten in die Auswahl.
Office.Settings	Stellt benutzerdefinierte Einstellungen für ein Aufgabenbereich- oder Inhalts-Add-In dar, die im Hostdokument als Name/Wert-Paare gespeichert werden.
Office.SettingsChangedEventArgs	Bietet Informationen zu den Einstellungen, durch die das Ereignis settingsChanged ausgelöst wurde. Verwenden Sie zum Hinzufügen eines Ereignishandlers für das settingsChanged-Ereignis die addHandlerAsync-Methode des Office.Settings-Objekts . Das Ereignis settingsChanged wird nur ausgelöst, wenn das Skript Ihres Add-Ins die Settings.saveAsync-Methode aufruft, um die In-Memory-Kopie der Einstellungen in der Dokumentdatei zu speichern. Das settingsChanged-Ereignis wird nicht ausgelöst, wenn die Methoden Settings.set oder Settings.remove aufgerufen werden. Das settingsChanged-Ereignis wurde entwickelt, damit Sie potenzielle Konflikte behandeln können, wenn zwei oder mehr Benutzer gleichzeitig versuchen, Einstellungen zu speichern, wenn Ihr Add-In in einem freigegebenen Dokument (gemeinsam erstellt) verwendet wird. Wichtig: Der Code Ihres Add-Ins kann einen Handler für das Ereignis "settingsChanged" registrieren, wenn das Add-In mit einem beliebigen Excel-Client ausgeführt wird. Das Ereignis wird jedoch nur ausgelöst, wenn dem Add-In eine Kalkulationstabelle geladen wird, die in Excel im Web geöffnet wird, und mehr als ein Benutzer die Kalkulationstabelle bearbeitet (gemeinsam dokumenter). Daher wird das settingsChanged-Ereignis effektiv nur in Excel im Web in Szenarien für die gemeinsame Dokumenterstellung unterstützt.
Office.Slice	Stellt ein Segment einer Dokumentdatei dar. Auf das Slice-Objekt wird mit der `File.getSliceAsync` Methode zugegriffen.
Office.Slide	Stellt eine einzelne Folie in einer PowerPoint-Präsentation dar. Diese Schnittstelle wird als Teil des Office.SlideRange-Objekts verwendet, das von Office.Document.getSelectedDataAsync zurückgegeben wird, wenn es mit Office.CoercionType.SlideRange aufgerufen wird.
Office.SlideRange	Stellt die ausgewählten Folien in einer PowerPoint-Präsentation dar. Dieses Objekt wird zurückgegeben, wenn Office.Document.getSelectedDataAsync mit Office.CoercionType.SlideRange in PowerPoint aufgerufen wird.
Office.Tab	Stellt eine einzelne Registerkarte und den Status dar, den sie aufweisen sollte. Codebeispiele finden Sie unter Ändern der Verfügbarkeit von Add-In-Befehlen und Erstellen benutzerdefinierter kontextbezogener Registerkarten.
Office.TableBinding	Stellt eine Bindung in zwei Dimensionen von Zeilen und Spalten dar, optional mit Kopfzeilen.
Office.TaskPane	Stellt Methoden zum Verwalten des Aufgabenbereichs eines Add-Ins bereit.
Office.TextBinding	Stellt eine gebundene Textauswahl im Dokument dar. Das TextBinding-Objekt erbt die Eigenschaft, die Typeigenschaft, die getDataAsync-Methode und die `id` setDataAsync-Methode vom Office.Binding-Objekt . Es implementiert keine eigenen zusätzlichen Eigenschaften oder Methoden.
Office.UI	Stellt Objekte und Methoden zum Erstellen und Bearbeiten von Benutzeroberflächenkomponenten, z. B. Dialogfeldern, in Ihren Office-Add-Ins bereit. Anleitungen zum Konfigurieren von Dialogfeldern finden Sie unter Verwenden der Dialog-API in Ihren Office-Add-Ins.
Office.Urls	Enthält die URLs der Laufzeitumgebungen, die von einem Add-In verwendet werden.
Office.VisibilityModeChangedMessage	Im Aufruf verwendete `onVisibilityModeChanged` Nachricht.
OfficeExtension.DebugInfo	Enthält Informationen zu einem Fehler.
OfficeExtension.EmbeddedOptions	Gibt Optionen für eine Sitzung eines Visio-Diagramms an, das in eine SharePoint-Seite eingebettet ist. Aufgerufen vom Konstruktor von `EmbeddedSession`. Weitere Informationen finden Sie unter Übersicht über die Visio-JavaScript-API.
OfficeExtension.EventInfo	Wird von Office zum Erstellen von Ereignishandlern verwendet. Rufen Sie Ihren Code nicht auf.
OfficeExtension.LoadOption	Gibt an, welche Eigenschaften eines Objekts geladen werden sollen. Dieser Ladevorgang erfolgt, wenn die sync()-Methode ausgeführt wird. Dadurch werden die Zustände zwischen Office-Objekten und entsprechenden JavaScript-Proxyobjekten synchronisiert.
OfficeExtension.RequestContextDebugInfo	Enthält Debuginformationen über den Anforderungskontext.
OfficeExtension.RequestUrlAndHeaderInfo	Anforderungs-URL und Header
OfficeExtension.RunOptions	Zusätzliche Optionen, die an übergeben werden `{Host}.run(...)`.
OfficeExtension.UpdateOptions	Bietet eine Option zum Unterdrücken eines Fehlers, wenn das Objekt, das zum Festlegen mehrerer Eigenschaften verwendet wird, versucht, schreibgeschützte Eigenschaften festzulegen.

Typaliase

OfficeExtension.IPromise

Enumerationen

Office.ActiveView	Gibt den Status der aktiven Ansicht des Dokuments an, z. B. ob der Benutzer das Dokument bearbeiten kann.
Office.AsyncResultStatus	Gibt das Ergebnis eines asynchronen Aufrufs an.
Office.BindingType	Gibt den Typ des Bindungsobjekts an, der zurückgegeben werden soll.
Office.CoercionType	Gibt an, wie Daten umgewandelt werden sollen, die von der aufgerufenen Methode zurückgegeben oder festgelegt wurden.
Office.CustomXMLNodeType	Gibt den Typ des XML-Knotens an.
Office.DevicePermissionType	Gibt die Gerätefunktion an, auf die ein Add-In Zugriff anfordert.
Office.DocumentMode	Gibt an, ob das Dokument in der zugeordneten Anwendung schreibgeschützt ist oder ob Lese-/Schreibzugriff besteht.
Office.EventType	Gibt an, welche Art von Ereignis ausgelöst wurde. Wird von der `type` Eigenschaft eines `*EventArgs` Objekts zurückgegeben. Add-Ins für Project unterstützen die `Office.EventType.ResourceSelectionChanged`Ereignistypen , `Office.EventType.TaskSelectionChanged`, und `Office.EventType.ViewSelectionChanged` Nur Aufgabenbereich-Add-Ins für Outlook unterstützen Postfach-API-Set-Ereignistypen.
Office.FileType	Gibt das Format an, in dem das Dokument zurückgegeben werden soll.
Office.FilterType	Gibt an, ob die Filterung aus der Office-Anwendung beim Abrufen der Daten angewendet wird.
Office.GoToType	Gibt den Typ des Orts oder Objekts an, zu dem navigiert werden soll.
Office.HostType	Gibt die Office-Anwendung an, in der das Add-In ausgeführt wird.
Office.Index	Gibt die relative PowerPoint-Folie an.
Office.InitializationReason	Gibt an, ob das Add-In gerade eingefügt wurde oder bereits im Dokument enthalten war.
Office.PlatformType	Gibt das Betriebssystem oder eine andere Plattform an, auf der die Office-Anwendung ausgeführt wird.
Office.ProjectProjectFields	Gibt die Projektfelder an, die als Parameter für die Document.getProjectFieldAsync-Methode verfügbar sind.
Office.ProjectResourceFields	Gibt die Ressourcenfelder an, die als Parameter für die Document.getResourceFieldAsync-Methode verfügbar sind.
Office.ProjectTaskFields	Gibt die Aufgabenfelder an, die als Parameter für die Document.getTaskFieldAsync-Methode verfügbar sind.
Office.ProjectViewTypes	Gibt die Arten von Ansichten an, die die Document.getSelectedViewAsync-Methode erkennen kann.
Office.SelectionMode	Gibt an, ob der Speicherort markiert werden soll, zu dem navigiert werden soll (bei Verwendung der Document.goToByIdAsync-Methode).
Office.StartupBehavior	Hier können Sie Optionen zum Festlegen des Startverhaltens des Add-Ins beim nächsten Start bereitstellen.
Office.Table	Gibt Aufzählungswerte für die `cells` Eigenschaft im cellFormat-Parameter von Tabellenformatierungsmethoden an.
Office.ThemeId	Gibt das aktuell ausgewählte Office-Design an. Informationen zu Office-Designs finden Sie unter Ändern des Aussehens und Verhaltens von Microsoft 365.
Office.ValueFormat	Gibt an, ob von der aufgerufenen Methode zurückgegebene Werte wie Zahlen und Datumsangaben mit angewendeten Formatierungen zurückgegeben werden.
Office.VisibilityMode	Sichtbarkeitsmodus des Add-Ins.

Functions

Office.initialize(reason)	Tritt ein, wenn die Laufzeitumgebung geladen wird und das Add-In bereit für die Interaktion mit der Anwendung und dem gehosteten Dokument ist. Der reason-Parameter der Initialize Event Listener-Funktion gibt einen `InitializationReason` Enumerationswert zurück, der angibt, wie die Initialisierung erfolgt ist. Es gibt zwei Möglichkeiten zum Initialisieren einer Aufgabenbereich- oder eines Inhalts-Add-Ins: Der Benutzer hat es gerade über den Abschnitt "Zuletzt verwendete Add-Ins" in der Dropdownliste "Add-In" auf der Registerkarte "Einfügen" des Menübands in der Office-Anwendung oder über das Dialogfeld "Add-In einfügen" eingefügt. Der Benutzer hat ein Dokument geöffnet, das das Add-In bereits enthält. Hinweis: Der Parameter reason der Initialize Event Listener-Funktion gibt nur einen `InitializationReason` Enumerationswert für Aufgabenbereich- und Inhalts-Add-Ins zurück. Es wird kein Wert für Outlook-Add-Ins zurückgegeben.
Office.isSetSupported(name, minVersion)	Überprüft, ob der angegebene Anforderungssatz von der Office-Anwendung unterstützt wird.
Office.onReady(callback)	Stellt sicher, dass die Office JavaScript-APIs für den Aufruf durch das Add-In bereit sind. Wenn das Framework noch nicht initialisiert wurde, wartet der Rückruf oder die Zusage, bis die Office-Anwendung bereit ist, API-Aufrufe zu akzeptieren. Beachten Sie, dass diese API zwar für die Verwendung innerhalb eines Office-Add-Ins vorgesehen ist, aber auch außerhalb des Add-Ins verwendet werden kann. Sobald Office.js in diesem Fall feststellt, dass es außerhalb einer Office-Anwendung ausgeführt wird, ruft es den Rückruf auf und löst die Zusage mit "null" für die Anwendung und die Plattform auf.
Office.select(expression, callback)	Gibt eine Zusage für ein im Ausdruck beschriebenes Objekt zurück. Callback wird nur aufgerufen, wenn die Funktion fehlschlägt.
Office.useShortNamespace(useShortNamespace)	Schaltet den `Office` Alias für den vollständigen `Microsoft.Office.WebExtension` Namespace ein und aus.

Office.initialize(reason)

Tritt ein, wenn die Laufzeitumgebung geladen wird und das Add-In bereit für die Interaktion mit der Anwendung und dem gehosteten Dokument ist.

Der reason-Parameter der Initialize Event Listener-Funktion gibt einen InitializationReason Enumerationswert zurück, der angibt, wie die Initialisierung erfolgt ist. Es gibt zwei Möglichkeiten zum Initialisieren einer Aufgabenbereich- oder eines Inhalts-Add-Ins:

Der Benutzer hat es gerade über den Abschnitt "Zuletzt verwendete Add-Ins" in der Dropdownliste "Add-In" auf der Registerkarte "Einfügen" des Menübands in der Office-Anwendung oder über das Dialogfeld "Add-In einfügen" eingefügt.
Der Benutzer hat ein Dokument geöffnet, das das Add-In bereits enthält.

Hinweis: Der Parameter reason der Initialize Event Listener-Funktion gibt nur einen InitializationReason Enumerationswert für Aufgabenbereich- und Inhalts-Add-Ins zurück. Es wird kein Wert für Outlook-Add-Ins zurückgegeben.

export function initialize(reason: InitializationReason): void;

Parameter

reason: Office.InitializationReason

Gibt an, wie die App initialisiert wurde.

Gibt zurück

void

Hinweise

Supportdetails

Weitere Informationen zu den Anforderungen an Office-Anwendungen und -Server finden Sie unter Anforderungen für die Ausführung von Office-Add-Ins.

Unterstützte Anwendungen nach Plattform

	Office im Web	Office unter Windows	Office für Mac	Office auf dem iPad	Outlook auf mobilen Geräten
Excel	Unterstützt	Unterstützt	Unterstützt	Unterstützt	Nicht zutreffend
Ausblick	Unterstützt	Unterstützt	Unterstützt	Unterstützt	Unterstützt
PowerPoint	Unterstützt	Unterstützt	Unterstützt	Unterstützt	Nicht zutreffend
Projekt	Nicht unterstützt	Unterstützt	Unterstützt	Nicht unterstützt	Nicht zutreffend
Word	Unterstützt	Unterstützt	Unterstützt	Unterstützt	Nicht zutreffend

Beispiele

// You can use the value of the InitializationEnumeration to implement different logic for
// when the add-in is first inserted versus when it is already part of the document.
// The following example shows some simple logic that uses the value of the reason parameter
// to display how the task pane or content add-in was initialized.
Office.initialize = function (reason) {
    // Checks for the DOM to load using the jQuery ready method.
    $(document).ready(function () {
        // After the DOM is loaded, code specific to the add-in can run.
        // Display initialization reason.
        if (reason === Office.InitializationReason.Inserted) {
            write("The add-in was just inserted.");
        }

        if (reason === Office.InitializationReason.DocumentOpened) {
            write("The add-in is already part of the document.");
        }
    });
}

// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

Office.isSetSupported(name, minVersion)

Warnung

Diese API ist nun veraltet.

This API returns inaccurate values when used on desktop applications. Use Office.context.requirements.isSetSupported instead.

Überprüft, ob der angegebene Anforderungssatz von der Office-Anwendung unterstützt wird.

export function isSetSupported(name: string, minVersion?: string): boolean;

Parameter

name: string

Name festlegen; z. B. "MatrixBindings".

minVersion: string

Die erforderliche Mindestversion; z. B. "1.4".

Gibt zurück

boolean

Office.onReady(callback)

Stellt sicher, dass die Office JavaScript-APIs für den Aufruf durch das Add-In bereit sind. Wenn das Framework noch nicht initialisiert wurde, wartet der Rückruf oder die Zusage, bis die Office-Anwendung bereit ist, API-Aufrufe zu akzeptieren. Beachten Sie, dass diese API zwar für die Verwendung innerhalb eines Office-Add-Ins vorgesehen ist, aber auch außerhalb des Add-Ins verwendet werden kann. Sobald Office.js in diesem Fall feststellt, dass es außerhalb einer Office-Anwendung ausgeführt wird, ruft es den Rückruf auf und löst die Zusage mit "null" für die Anwendung und die Plattform auf.

export function onReady(callback?: (info: { host: HostType, platform: PlatformType }) => any): Promise<{ host: HostType, platform: PlatformType }>;

Parameter

callback: (info: { host: Office.HostType, platform: Office.PlatformType }) => any

Eine optionale Rückruffunktion, die die Anwendungs- und Plattforminformationen empfängt. Anstatt einen Rückruf zu verwenden, kann ein Add-In alternativ einfach warten, bis das von der Funktion zurückgegebene Promise aufgelöst wird.

Gibt zurück

Promise<{ host: Office.HostType, platform: Office.PlatformType }>

Eine Zusage, die die Anwendungs- und Plattforminformationen enthält, sobald die Initialisierung abgeschlossen ist.

Beispiele

Office.onReady(function(info) {
    if (info.host === Office.HostType.Excel) {
        // Do Excel-specific initialization (for example, make add-in task pane's
        // appearance compatible with Excel "green").
    }
    if (info.platform === Office.PlatformType.PC) {
        // Make minor layout changes in the task pane.
    }
    console.log(`Office.js is now ready in ${info.host} on ${info.platform}`);
});

Office.select(expression, callback)

Gibt eine Zusage für ein im Ausdruck beschriebenes Objekt zurück. Callback wird nur aufgerufen, wenn die Funktion fehlschlägt.

export function select(expression: string, callback?: (result: AsyncResult<any>) => void): Binding;

Parameter

expression: string

Das abzurufende Objekt. Beispiel "bindings#BindingName", ruft eine Bindungszusage für eine Bindung mit dem Namen "BindingName" ab

callback: (result: Office.AsyncResult<any>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgegeben wird, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

Office.Binding

Hinweise

Supportdetails

Weitere Informationen zu den Anforderungen an Office-Anwendungen und -Server finden Sie unter Anforderungen für die Ausführung von Office-Add-Ins.

Unterstützte Anwendungen nach Plattform

	Office im Web	Office unter Windows	Office auf dem iPad
Excel	Unterstützt	Unterstützt	Unterstützt
Word	Nicht unterstützt	Unterstützt	Unterstützt

Beispiele

// The following code example uses the select function to retrieve a binding with the id "cities" from
// the Bindings collection, and then calls the addHandlerAsync method to add an event handler for the
// dataChanged event of the binding.
function addBindingDataChangedEventHandler() {
    Office.select("bindings#cities", function onError(){}).addHandlerAsync(Office.EventType.BindingDataChanged,
    function (eventArgs) {
        doSomethingWithBinding(eventArgs.binding);
    });
}

Office.useShortNamespace(useShortNamespace)

Schaltet den Office Alias für den vollständigen Microsoft.Office.WebExtension Namespace ein und aus.

export function useShortNamespace(useShortNamespace: boolean): void;

Parameter

useShortNamespace: boolean

True, um den Verknüpfungsalias zu verwenden; andernfalls false verwenden, um sie zu deaktivieren. Der Standardwert ist "true".

Gibt zurück

void

Hinweise

Supportdetails

Weitere Informationen zu den Anforderungen an Office-Anwendungen und -Server finden Sie unter Anforderungen für die Ausführung von Office-Add-Ins.

Unterstützte Anwendungen nach Plattform

	Office im Web	Office unter Windows	Office für Mac	Office auf dem iPad	Outlook auf mobilen Geräten
Excel	Unterstützt	Unterstützt	Nicht unterstützt	Unterstützt	Nicht zutreffend
Ausblick	Unterstützt	Unterstützt	Unterstützt	Unterstützt	Unterstützt
PowerPoint	Unterstützt	Unterstützt	Nicht unterstützt	Unterstützt	Nicht zutreffend
Projekt	Nicht unterstützt	Unterstützt	Nicht unterstützt	Nicht unterstützt	Nicht zutreffend
Word	Unterstützt	Unterstützt	Nicht unterstützt	Unterstützt	Nicht zutreffend

Beispiele

function startUsingShortNamespace() {
    if (typeof Office === 'undefined') {
        Microsoft.Office.WebExtension.useShortNamespace(true);
    } else {
        Office.useShortNamespace(true);
    }
    write('Office alias is now ' + typeof Office);
}

function stopUsingShortNamespace() {
    if (typeof Office === 'undefined') {
        Microsoft.Office.WebExtension.useShortNamespace(false);
    } else {
        Office.useShortNamespace(false);
    }
    write('Office alias is now ' + typeof Office);
}

// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

Klassen

Schnittstellen

Typaliase

Enumerationen

Functions

Details zur Funktion

Office.initialize(reason)

Parameter

Gibt zurück

Hinweise

Beispiele

Office.isSetSupported(name, minVersion)

Parameter

Gibt zurück

Office.onReady(callback)

Parameter

Gibt zurück

Beispiele

Office.select(expression, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

Office.useShortNamespace(useShortNamespace)

Parameter

Gibt zurück

Hinweise

Beispiele

Feedback