office package

Klassen

Office.TableData

Represents the data in a table or an Office.TableBinding.

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 Befehle zu einer Warteschlange hinzu, um auf das Objekt zu wirken, und synchronisieren dann den Proxyobjektstatus mit dem Dokument, indem Sie context.sync().

OfficeExtension.ClientRequestContext

Ein abstraktes RequestContext-Objekt, das Anforderungen an die Host-Office-Anwendung erleichtert. Die Excel.run Word.run und-Methoden stellen einen Anforderungskontext zur Verfügung.

OfficeExtension.ClientResult

Enthält das Ergebnis für Methoden, die primitive Typen zurückgeben. Die Value-Eigenschaft des Objekts wird nach dem Aufruf aus context.sync() dem Dokument abgerufen.

OfficeExtension.EmbeddedSession
OfficeExtension.Error

Das von zurückgegebene Fehlerobjekt context.sync(), wenn eine Zusage aufgrund eines Fehlers bei der Verarbeitung der Anforderung abgelehnt wird.

OfficeExtension.ErrorCodes
OfficeExtension.EventHandlerResult
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 zur Verfügung.

Office.AddBindingFromPromptOptions

Stellt Optionen zum Konfigurieren der Eingabeaufforderung und zum Identifizieren der erstellten Bindung zur Verfügung.

Office.AddBindingFromSelectionOptions

Stellt Optionen zum Identifizieren der erstellten Bindung zur Verfügung.

Office.Addin

Stellt Funktionen auf Add-In-Ebene zum Ausführen oder Konfigurieren verschiedener Aspekte des Add-Ins dar.

Office.AddinCommands.Event

Das Event-Objekt wird als ein Parameter an Add-In-Funktionen übergeben, die von Befehlsschaltflächen ohne Benutzeroberfläche aufgerufen werden. Das Objekt ermöglicht dem Add-In, zu erkennen, auf welche Schaltfläche geklickt wurde, und dem Host zu signalisieren, dass die Verarbeitung abgeschlossen wurde.

Office.AddinCommands.EventCompletedOptions

Gibt das Verhalten für den Abschluss des Ereignisses an.

Office.AddinCommands.Source

Kapselt Quelldaten für Add-In-Ereignisse.

Office.AsyncContextOptions

Stellt eine Option zum Beibehalten von Kontextdaten eines beliebigen Typs zur Verwendung in einem Rückruf zur Verfügung.

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 An den Parameter einer "Async"-Methode übergebene Funktion ausgeführt wird, erhält sie ein AsyncResult-Objekt, auf das Sie über den einzigen Parameter der callback callback Funktion zugreifen können.

Office.Auth

Der Office-Authentifizierungsnamespace,Office.authbietet eine Methode, mit der die Office Clientanwendung ein Zugriffstoken für die Webanwendung des Add-Ins abrufen kann. 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.AuthOptions

Stellt Optionen für die Benutzeroberfläche zur Verfügung, wenn Office ein Zugriffstoken für das Add-In von AAD v erhält. 2.0 abruft (mit der Methode getAccessToken).

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. Das Benachrichtigungsdialogfeld ermöglicht es dem Benutzer, die Anforderung zum Schließen des Dokuments zu bestätigen oder die Anforderung zum Schließen des Dokuments abzubrechen.

Office. Bindung

Stellt eine Bindung an einen Abschnitt des Dokuments dar.

Das Binding-Objekt macht die Funktionalität aller Bindungen verfügbar, unabhängig vom Typ.

Das Binding-Objekt wird nie direkt aufgerufen. Es ist die abstrakte übergeordnete Klasse der Objekte, die jeden Bindungstyp darstellen: Office. MatrixBinding, Office. TableBindingoder Office. TextBinding. Alle drei dieser Objekte erben die Methoden getDataAsync und setDataAsync vom Binding-Objekt, mit denen Sie mit den Daten in der Bindung interagieren können. Außerdem erben sie 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. Der Zugriff wird mithilfe von Office.context.

Office.ContextInformation

Enthält Informationen über die Umgebung, in der das Add-in läuft.

Office.Control

Stellt ein einzelnes Steuerelement oder einen befehl und den Zustand dar, den es aufweisen soll.

Codebeispiele zur Verwendung eines Control Objekts und seiner Eigenschaften finden Sie unter Aktivieren und Deaktivieren von Add-In-Befehlen und Erstellen benutzerdefinierter kontextbezogener Registerkarten.

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.Dialog

Das Objekt, das beim Aufruf zurückgegeben UI.displayDialogAsync wird. Es macht Methoden zum Registrieren von Ereignishandlern und Schließen des Dialogfelds verfügbar.

Office.DialogMessageOptions

Bietet Optionen zum Senden von Nachrichten zwischen einem Dialogfeld und dem übergeordneten Element in beide Richtungen.

Office.DialogOptions

Stellt Optionen für die Anzeige eines Dialogfelds zur Verfügung.

Office.DialogParentMessageReceivedEventArgs

Stellt Informationen zu der Nachricht von der übergeordneten Seite bereit, die das Ereignis ausgelöst DialogParentMessageReceived hat.

Verwenden Sie zum Hinzufügen eines Ereignishandlers für das DialogParentMessageReceived Ereignis die Methode des addHandlerAsync Office. UI-Objekt.

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

Enthält Optionen zum Erhalten der Daten in einer Bindung.

Office.GetFileOptions

Stellt Optionen zum Festlegen der Größe von Segmenten bereit, in die das Dokument unterteilt wird.

Office.GetSelectedDataOptions

Stellt Optionen zum Anpassen der zurückgegebenen Daten und deren Formatierung zur Verfügung.

Office.GoToByIdOptions

Stellt Optionen für die Auswahl des Speicherorts zur Verfügung, zu dem navigiert wird.

Office.Group

Stellt eine Gruppe von Steuerelementen auf einer Menübandregisterkarte dar.

Anforderungssatz: Menüband 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 der Benutzer mit der Benutzeroberfläche des Office-Konto-Office-Designs ausgewählt hat, das auf alle Office-Hostanwendungen > > angewendet wird. Using Office theme colors is appropriate for mail and task pane add-ins.

Office.RangeCoordinates

Gibt eine Zelle oder Zeile oder Spalte anhand der nullbasierten Zeilen- und/oder Spaltennummer an. Beispiel: gibt die Zelle in der {row: 3, column: 4} dritten Zeile (nullbasierte) in der 4. Spalte (nullbasierte Spalte) an.

Office.RangeFormatConfiguration

Gibt einen Bereich und dessen Formatierung an.

Office.RemoveHandlerOptions

Stellt Optionen zur Verfügung, 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 zum Verwalten des Status des Menübands Office enthält.

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 zur Verfügung.

Office.SetBindingDataOptions

Enthält Optionen zum Festlegen der Daten in einer Bindung.

Office.SetSelectedDataOptions

Enthält 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 settingsChanged-Ereignis wird nur ausgelöst, wenn das Skript ihres Add-Ins die Settings.saveAsync-Methode aufruft, um die im Arbeitsspeicher gespeicherte 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 so konzipiert, dass Sie potenzielle Konflikte behandeln können, wenn zwei oder mehr Benutzer gleichzeitig versuchen, Einstellungen zu speichern, wenn Ihr Add-In in einem freigegebenen (gemeinsam authentifizierten) 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. Das Ereignis wird jedoch nur ausgelöst, wenn das Add-In mit einer Kalkulationstabelle geladen wird, die in Excel im Web geöffnet wird, und mehrere Benutzer die Kalkulationstabelle bearbeiten (mitautorisieren). Daher wird das settingsChanged-Ereignis nur in Excel im Web in Gemeinsamen Dokumentierungsszenarien unterstützt.

Office.Slice

Stellt ein Segment einer Dokumentdatei dar. Auf das Slice-Objekt wird mit der -Methode File.getSliceAsync zugegriffen.

Office.Tab

Stellt eine einzelne Registerkarte und den Status dar, den sie haben sollte. Codebeispiele finden Sie unter Aktivieren und Deaktivieren 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.TextBinding

Stellt eine gebundene Textauswahl im Dokument dar.

Das TextBinding-Objekt erbt die id-Eigenschaft, type-Eigenschaft, getDataAsync-Methode und setDataAsync-Methode vom Office.Binding-Objekt. Es implementiert keine eigenen zusätzlichen Eigenschaften oder Methoden.

Office.UI

Stellt Objekte und Methoden bereit, die Sie zum Erstellen und Bearbeiten von UI-Komponenten wie Dialogfeldern in Ihren Office-Add-Ins verwenden können.

Besuchen Sie "Verwenden der Dialog-API in Ihren Office-Add-Ins." für weitere Informationen.

Office.VisibilityModeChangedMessage

Im Aufruf verwendete Nachricht onVisibilityModeChanged .

OfficeExtension.DebugInfo

Stellt Informationen zu einem Fehler zur Verfügung.

OfficeExtension.EmbeddedOptions
OfficeExtension.EventInfo
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 Kopfzeilen

OfficeExtension.RunOptions

Zusätzliche Optionen, die ü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 zu setzen.

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.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 dieOffice.EventType.ResourceSelectionChanged, Office.EventType.TaskSelectionChangedund Office.EventType.ViewSelectionChanged Ereignistypen.

Nur Aufgabenbereich-Add-Ins für Outlook unterstützen Ereignistypen für Postfach-API-Sätze.

Office.FileType

Gibt das Format an, in dem das Dokument zurückgegeben werden soll.

Office.FilterType

Gibt an, ob Filtern von der Hostanwendung 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-Hostanwendung 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-Hostanwendung ausgeführt wird.

Office.ProjectProjectFields

Gibt die Projektfelder an, die als Parameter für das Dokument verfügbar sind.getProjectFieldAsync-Methode.

Office.ProjectResourceFields

Gibt die Ressourcenfelder an, die als Parameter für das Dokument verfügbar sind..getResourceFieldAsync-Methode.

Office.ProjectTaskFields

Gibt die Vorgangsfelder an, die als Parameter für das Dokument verfügbar sind..getTaskFieldAsync-Methode.

Office.ProjectViewTypes

Gibt die Arten von Ansichten an, die das Dokument.getSelectedViewAsync-Methode kann erkannt werden.

Office.SelectionMode

Gibt an, ob der zu navigierende Speicherort ausgewählt (hervorgehoben) werden soll (bei Verwendung des Dokuments.goToByIdAsync-Methode).

Office.StartupBehavior

Stellt Optionen zum Bestimmen des Startverhaltens des Add-Ins beim nächsten Start zur Verfügung.

Office.Table

Gibt aufgezählte Werte für die Eigenschaft cells im cellFormat-Parameter von Tabellenformatierungsmethoden an..

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 Listenerfunktion zum Initialisieren 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 im Office Hostanwendung 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 Listenerfunktion zum Initialisieren des Ereignisses 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 Hostanwendung Office 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 der Office Host bereit ist, API-Aufrufe zu akzeptieren. 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. In diesem Fall ruft Office.js fest, dass sie außerhalb einer Office Hostanwendung ausgeführt wird, den Rückruf und löst die Zusage mit "null" für den Host und die Plattform auf.

Office.select(expression, callback)

Gibt eine Zusage eines im Ausdruck beschriebenen Objekts zurück. Rückruf wird nur aufgerufen, wenn die Methode fehlschlägt.

Office.useShortNamespace(useShortNamespace)

Schaltet den Alias für den vollständigen Namespace ein und Office Microsoft.Office.WebExtension 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 Listenerfunktion zum Initialisieren 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 im Office Hostanwendung 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 Listenerfunktion zum Initialisieren des Ereignisses 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

Ein Häkchen (v) in der folgenden Matrix weist darauf hin, dass diese Methode in der entsprechenden Office-Hostanwendung unterstützt wird. Eine leere Zelle weist darauf hin, dass die Office-Hostanwendung diese Methode nicht unterstützt.

Weitere Informationen zu Office Hostanwendungs- und Serveranforderungen finden Sie unter "Anforderungen für die Ausführung von Office-Add-Ins"..

Unterstützte Hosts nach Plattform

Office unter Windows Office im Webbrowser Office auf dem iPad Outlook auf mobilen Geräten Office für Mac
Excel v v v v
Outlook v v v v
PowerPoint v v v v
Project v v
Wort v v v v

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 function.
    $(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 Hostanwendung Office 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 der Office Host bereit ist, API-Aufrufe zu akzeptieren. 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. In diesem Fall ruft Office.js fest, dass sie außerhalb einer Office Hostanwendung ausgeführt wird, den Rückruf und löst die Zusage mit "null" für den Host 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ückrufmethode, die die Host- und Plattforminformationen empfängt. Alternativ kann ein Add-In einfach warten, bis die von der Funktion zurückgegebene Zusage aufgelöst wird, anstatt einen Rückruf zu verwenden.

Gibt zurück

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

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

Office.select(expression, callback)

Gibt eine Zusage eines im Ausdruck beschriebenen Objekts zurück. Rückruf wird nur aufgerufen, wenn die Methode fehlschlägt.

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

Parameter

expression

string

Das abzurufende Objekt. Beispiel "bindings # BindingName", ruft eine Bindungszusagen für eine Bindung namens "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 ist. AsyncResult.

Gibt zurück

Hinweise

Supportdetails

Ein Häkchen (v) in der folgenden Matrix weist darauf hin, dass diese Methode in der entsprechenden Office-Hostanwendung unterstützt wird. Eine leere Zelle weist darauf hin, dass die Office-Hostanwendung diese Methode nicht unterstützt.

Weitere Informationen zu Office Hostanwendungs- und Serveranforderungen finden Sie unter "Anforderungen für die Ausführung von Office-Add-Ins"..

Unterstützte Hosts nach Plattform

Office unter Windows Office im Webbrowser Office auf dem iPad
Excel v v v
Wort v v

Beispiele

// The following code example uses the select method 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 vollständigen Namespace ein und Office Microsoft.Office.WebExtension aus.

export function useShortNamespace(useShortNamespace: boolean): void;

Parameter

useShortNamespace

boolean

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

Gibt zurück

void

Hinweise

Supportdetails

Ein Häkchen (v) in der folgenden Matrix weist darauf hin, dass diese Methode in der entsprechenden Office-Hostanwendung unterstützt wird. Eine leere Zelle weist darauf hin, dass die Office-Hostanwendung diese Methode nicht unterstützt.

Weitere Informationen zu Office Hostanwendungs- und Serveranforderungen finden Sie unter "Anforderungen für die Ausführung von Office-Add-Ins"..

Unterstützte Hosts nach Plattform

Office unter Windows Office im Webbrowser Office auf dem iPad Outlook auf mobilen Geräten Office für Mac
Excel v v v
Outlook v v v v
PowerPoint v v v
Project J
Wort v v v

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; 
}