office package

Referenz

Klassen

Office.TableData	Stellt die Daten in einer Tabelle oder einer Office.TableBinding 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 Proxyobjektzustand mit dem Dokument, indem Sie aufrufen `context.sync()`.
OfficeExtension.ClientRequestContext	Ein abstraktes RequestContext-Objekt, das Anforderungen an die Office-Anwendung erleichtert. Die `Excel.run` Methoden und `Word.run` stellen einen Anforderungskontext bereit.
OfficeExtension.ClientResult	Enthält das Ergebnis für Methoden, die primitive Typen zurückgeben. Die value-Eigenschaft des Objekts wird aus dem Dokument abgerufen, nachdem `context.sync()` aufgerufen wurde.
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 von `context.sync()`zurückgegebene Fehlerobjekt, 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 Allgemeine Office-API-Fehlercodes.
OfficeExtension.EventHandlerResult	Ermöglicht das Entfernen eines Ereignishandlers. Wird von der `EventHandlers.add` -Methode zurückgegeben. Hinweis: Dasselbe RequestContext-Objekt , in dem der Handler hinzugefügt wurde, muss beim Entfernen des Handlers verwendet werden. Weitere Informationen finden Sie unter Entfernen eines Ereignishandlers.
OfficeExtension.EventHandlers
OfficeExtension.TrackedObjects	Auflistung von nachverfolgten Objekten, die in einem Anforderungskontext enthalten sind. Weitere Informationen finden Sie unter context.trackedObjects .

Schnittstellen

Office.Actions	Verwaltet Aktionen und Tastenkombinationen.
Office.AddBindingFromNamedItemOptions	Stellt Optionen zum Konfigurieren der erstellten Bindung bereit.
Office.AddBindingFromPromptOptions	Stellt Optionen zum Konfigurieren der Eingabeaufforderung und Identifizieren der erstellten Bindung bereit.
Office.AddBindingFromSelectionOptions	Stellt Optionen zum Identifizieren der erstellten Bindung bereit.
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. Mit dem -Objekt kann das Add-In erkennen, auf welche Schaltfläche geklickt wurde, und der Office-Anwendung signalisieren, dass die Verarbeitung abgeschlossen wurde.
Office.AddinCommands.EventCompletedOptions	Gibt das Verhalten eines On-Send-Add-Ins in Outlook an, wenn es die Verarbeitung eines `ItemSend` Ereignisses abgeschlossen hat.
Office.AddinCommands.Source	Kapselt Quelldaten für Add-In-Ereignisse.
Office.AsyncContextOptions	Bietet eine Option zum Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die 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 Auth-Namespace stellt Methoden für die Office-Clientanwendung bereit, `Office.auth`um Zugriffstoken für 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 msal.js übergeben werden können.
Office.AuthOptions	Stellt Optionen für die Benutzeroberfläche bereit, wenn Office ein Zugriffstoken für das Add-In von AAD v. 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 verfügbar, die von allen Bindungen unabhängig vom Typ besitzt. Das Binding-Objekt wird nie direkt aufgerufen. Es ist die abstrakte übergeordnete Klasse der Objekte, die jeden Bindungstyp darstellen: Office.MatrixBinding, Office.TableBinding oder Office.TextBinding. Alle drei Objekte erben die Methoden getDataAsync und setDataAsync vom Binding-Objekt, mit denen Sie mit den Daten in der Bindung interagieren können. Sie erben auch die ID- und Typeigenschaften zum Abfragen dieser Eigenschaftswerte. Darüber hinaus machen die MatrixBinding- und TableBinding-Objekte zusätzliche Methoden für matrix- und tabellenspezifische Features verfügbar, 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 ist als Eigenschaft von Office vorhanden. Auf sie wird mithilfe von `Office.context`zugegriffen.
Office.ContextInformation	Stellt Informationen zu der Umgebung bereit, in der das Add-In ausgeführt wird.
Office.Control	Stellt ein einzelnes Steuerelement oder einen einzelnen Befehl und den Zustand dar, den es haben soll.
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 für den Zugriff auf seine Gerätefunktionen anzufordern. Zu den Gerätefunktionen eines Benutzers gehören kamera, geolocation und mikrofon.
Office.Dialog	Das Objekt, das zurückgegeben wird, wenn `UI.displayDialogAsync` aufgerufen wird. Es macht Methoden zum Registrieren von Ereignishandlern und Zum Schließen des Dialogs verfügbar.
Office.DialogMessageOptions	Bietet Optionen zum Senden von Nachrichten in beide Richtungen zwischen einem Dialog und seinem übergeordneten Element.
Office.DialogOptions	Stellt Optionen für die Anzeige eines Dialogfelds bereit.
Office.DialogParentMessageReceivedEventArgs	Stellt Informationen zur Nachricht von der übergeordneten Seite bereit, die das `DialogParentMessageReceived` Ereignis ausgelöst hat. Um einen Ereignishandler für das `DialogParentMessageReceived` Ereignis hinzuzufügen, verwenden Sie 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.File	Stellt die einem Office Add-In zugeordnete Dokumentdatei dar.
Office.FileProperties
Office.GetBindingDataOptions	Stellt Optionen zum Abrufen der Daten in einer Bindung bereit.
Office.GetFileOptions	Bietet Optionen zum Festlegen der Größe von Segmenten, in die das Dokument unterteilt wird.
Office.GetSelectedDataOptions	Bietet Optionen zum Anpassen, welche Daten zurückgegeben und wie sie formatiert werden.
Office.GoToByIdOptions	Stellt Optionen bereit, die angeben, ob der Speicherort ausgewählt werden soll, zu dem navigiert wird.
Office.Group	Stellt eine Gruppe von Steuerelementen auf einer Menübandregisterkarte 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. Mithilfe von Office-Designfarben können Sie das Farbschema Ihres Add-Ins mit dem aktuellen Office-Design koordinieren, das vom Benutzer ausgewählt wurde. Der Benutzer legt ein Design in einer Office-Anwendung über das Office-Design "Dateikonto"> oder "Office-Konto">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.RangeCoordinates	Gibt eine Zelle, Zeile oder Spalte anhand der nullbasierten Zeile und/oder Spaltennummer an. Beispiel: `{row: 3, column: 4}` Gibt die Zelle in der dritten (nullbasierten) Zeile in der 4. (nullbasierten) Spalte an.
Office.RangeFormatConfiguration	Gibt einen Bereich und dessen Formatierung an.
Office.RemoveHandlerOptions	Stellt Optionen bereit, um zu bestimmen, welche Ereignishandler oder Handler entfernt werden.
Office.RequirementSetSupport	Enthält Informationen dazu, 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	Stellt Optionen zum Speichern von Einstellungen bereit.
Office.SetBindingDataOptions	Stellt Optionen zum Festlegen der Daten in einer Bindung bereit.
Office.SetSelectedDataOptions	Stellt Optionen zum Einfügen von Daten in die Auswahl bereit.
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. Um einen Ereignishandler für das settingsChanged-Ereignis hinzuzufügen, verwenden Sie die addHandlerAsync-Methode des Office.Settings-Objekts . Das SettingsChanged-Ereignis wird nur ausgelöst, wenn das Skript Ihres Add-Ins die Settings.saveAsync-Methode aufruft, um die Speicherkopie der Einstellungen in der Dokumentdatei beizubehalten. 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 (mitverfassten) Dokument verwendet wird. Wichtig: Der Code Ihres Add-Ins kann einen Handler für das settingsChanged-Ereignis registrieren, wenn das Add-In mit einem beliebigen Excel-Client ausgeführt wird, aber das Ereignis wird nur ausgelöst, wenn das Add-In mit einer Kalkulationstabelle geladen wird, die in Excel im Web geöffnet ist und mehrere Benutzer die Tabelle bearbeiten (gemeinsame Dokumenterstellung). Daher wird das settingsChanged-Ereignis in Szenarien mit der gemeinsamen Dokumenterstellung nur in Excel im Web unterstützt.
Office.Slice	Stellt ein Segment einer Dokumentdatei dar. Auf das Slice-Objekt wird mit der `File.getSliceAsync` -Methode zugegriffen.
Office.Tab	Stellt eine einzelne Registerkarte und den Zustand dar, den sie haben soll. Codebeispiele finden Sie unter Aktivieren und Deaktivieren von Add-In-Befehlen und Erstellen von benutzerdefinierten Kontextregisterkarten.
Office.TableBinding	Stellt eine Bindung in zwei Dimensionen von Zeilen und Spalten dar, optional mit Kopfzeilen.
Office.TextBinding	Stellt eine gebundene Textauswahl im Dokument dar. Das TextBinding-Objekt erbt die Eigenschaft, die `id` Type-Eigenschaft, die getDataAsync-Methode und die setDataAsync-Methode vom Office.Binding-Objekt . Es implementiert keine eigenen zusätzlichen Eigenschaften oder Methoden.
Office.UI	Stellt Objekte und Methoden bereit, mit denen Sie Benutzeroberflächenkomponenten wie Dialogfelder in Ihren Office-Add-Ins erstellen und bearbeiten können. Weitere Informationen finden Sie unter Verwenden der Dialog-API in Ihren Office-Add-Ins.
Office.Urls	Stellt die URLs der Laufzeitumgebungen bereit, die von einem Add-In verwendet werden.
Office.VisibilityModeChangedMessage	Nachricht, die `onVisibilityModeChanged` beim Aufruf verwendet wird.
OfficeExtension.DebugInfo	Stellt Informationen zu einem Fehler bereit.
OfficeExtension.EmbeddedOptions	Gibt Optionen für eine Sitzung eines Visio-Diagramms an, das in eine SharePoint-Seite eingebettet ist. Wird vom Konstruktor von `EmbeddedSession`aufgerufen. 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. Diese Last tritt auf, 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 zum Anforderungskontext.
OfficeExtension.RequestUrlAndHeaderInfo	Anforderungs-URL und Header
OfficeExtension.RunOptions	Zusätzliche Optionen, die an `{Host}.run(...)`übergeben wurden.
OfficeExtension.UpdateOptions	Stellt eine Option zum Unterdrücken eines Fehlers bereit, 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 angewendet wird, wenn die Daten abgerufen werden.
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 Typen von Ansichten an, die die Document.getSelectedViewAsync-Methode erkennen kann.
Office.SelectionMode	Gibt an, ob der Speicherort ausgewählt (hervorgehoben) werden soll, zu dem navigiert werden soll (bei Verwendung der Document.goToByIdAsync-Methode).
Office.StartupBehavior	Bietet Optionen zum Bestimmen des Startverhaltens des Add-Ins beim nächsten Start.
Office.Table	Gibt aufgezählte Werte 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-Ereignislistenerfunktion 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 aus dem Abschnitt Zuletzt verwendete Add-Ins der Add-In-Dropdownliste auf der Registerkarte Einfügen des Menübands in der Office-Anwendung oder im Dialogfeld Add-In einfügen eingefügt. Der Benutzer hat ein Dokument geöffnet, das das Add-In bereits enthält. Hinweis: Der Reason-Parameter der Initialize-Ereignislistenerfunktion gibt nur einen `InitializationReason` Enumerationswert für Aufgabenbereich- und Inhalts-Add-Ins zurück. Für Outlook-Add-Ins wird kein Wert 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 bereit sind, vom Add-In aufgerufen zu werden. Wenn das Framework noch nicht initialisiert wurde, wartet der Rückruf oder die Zusage, bis die Office-Anwendung bereit ist, API-Aufrufe anzunehmen. Beachten Sie, dass diese API zwar für die Verwendung innerhalb eines Office-Add-Ins vorgesehen ist, sie aber auch außerhalb des Add-Ins verwendet werden kann. Sobald Office.js festgestellt hat, dass sie außerhalb einer Office-Anwendung ausgeführt wird, ruft sie in diesem Fall den Rückruf auf und löst die Zusage sowohl für die Anwendung als auch für die Plattform mit "NULL" auf.
Office.select(expression, callback)	Gibt eine Zusage eines im Ausdruck beschriebenen Objekts zurück. Der Rückruf wird nur aufgerufen, wenn die Funktion fehlschlägt.
Office.useShortNamespace(useShortNamespace)	Schaltet den Alias für den `Office` vollständigen `Microsoft.Office.WebExtension` Namespace ein und aus.

Details zur Funktion

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-Ereignislistenerfunktion 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 aus dem Abschnitt Zuletzt verwendete Add-Ins der Add-In-Dropdownliste auf der Registerkarte Einfügen des Menübands in der Office-Anwendung oder im Dialogfeld Add-In einfügen eingefügt.
Der Benutzer hat ein Dokument geöffnet, das das Add-In bereits enthält.

Hinweis: Der Reason-Parameter der Initialize-Ereignislistenerfunktion gibt nur einen InitializationReason Enumerationswert für Aufgabenbereich- und Inhalts-Add-Ins zurück. Für Outlook-Add-Ins wird kein Wert 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 Office-Anwendungs- und Serveranforderungen 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
Ausstechen	Unterstützt	Unterstützt	Unterstützt	Unterstützt	Nicht zutreffend
Aussicht	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
Wort	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 == "inserted")
    write("The add-in was just inserted.");

    if (reason == "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)

Ü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 mindestens erforderliche Version; z. B. "1.4".

Gibt zurück

boolean

Office.onReady(callback)

Stellt sicher, dass die Office-JavaScript-APIs bereit sind, vom Add-In aufgerufen zu werden. Wenn das Framework noch nicht initialisiert wurde, wartet der Rückruf oder die Zusage, bis die Office-Anwendung bereit ist, API-Aufrufe anzunehmen. Beachten Sie, dass diese API zwar für die Verwendung innerhalb eines Office-Add-Ins vorgesehen ist, sie aber auch außerhalb des Add-Ins verwendet werden kann. Sobald Office.js festgestellt hat, dass sie außerhalb einer Office-Anwendung ausgeführt wird, ruft sie in diesem Fall den Rückruf auf und löst die Zusage sowohl für die Anwendung als auch für die Plattform mit "NULL" 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 auch einfach warten, bis die von der Funktion zurückgegebene Zusage aufgelöst wurde.

Gibt zurück

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

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

Office.select(expression, callback)

Gibt eine Zusage eines im Ausdruck beschriebenen Objekts zurück. Der Rückruf 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 namens "BindingName" ab.

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

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

Gibt zurück

Office.Binding

Hinweise

Supportdetails

Weitere Informationen zu Office-Anwendungs- und Serveranforderungen 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
Ausstechen	Unterstützt	Unterstützt	Unterstützt
Wort	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 Alias für den Office 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, um sie zu deaktivieren. Der Standardwert ist "true".

Gibt zurück

void

Hinweise

Supportdetails

Weitere Informationen zu Office-Anwendungs- und Serveranforderungen 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
Ausstechen	Unterstützt	Unterstützt	Nicht unterstützt	Unterstützt	Nicht zutreffend
Aussicht	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
Wort	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; 
}

Freigeben über

office package

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

Office.select(expression, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

Office.useShortNamespace(useShortNamespace)

Parameter

Gibt zurück

Hinweise

Beispiele

Zusätzliche Ressourcen