Excel.LinkedDataType class

  • Referenz
Paket:
excel

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt einen verknüpften Datentyp dar. Ein verknüpfter Datentyp ist ein Datentyp, der mit einer Onlinedatenquelle verbunden ist.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

Eigenschaften

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
dataProvider

Der Name des Datenanbieters für den verknüpften Datentyp. Dies kann sich ändern, wenn Informationen aus dem Dienst abgerufen werden.
lastRefreshed

Das Datum und die Uhrzeit der lokalen Zeitzone seit dem Öffnen der Arbeitsmappe, als der verknüpfte Datentyp zuletzt aktualisiert wurde. Gibt zurück undefined , wenn der verknüpfte Datentyp nicht aktualisiert wurde.
name

Der Name des verknüpften Datentyps. Dies kann sich ändern, wenn Informationen aus dem Dienst abgerufen werden.
periodicRefreshInterval

Die Häufigkeit in Sekunden, mit der der verknüpfte Datentyp aktualisiert wird, wenn refreshMode auf "Periodisch" festgelegt ist.
refreshMode

Der Mechanismus, mit dem die Daten für den verknüpften Datentyp abgerufen werden.
serviceId

Die eindeutige ID des verknüpften Datentyps.
supportedRefreshModes

Gibt ein Array mit allen Aktualisierungsmodi zurück, die vom verknüpften Datentyp unterstützt werden. Der Inhalt des Arrays kann sich ändern, wenn Informationen vom Dienst abgerufen werden.

Methoden

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
requestRefresh()

Sendet eine Anforderung zum Aktualisieren des verknüpften Datentyps. Wenn der Dienst ausgelastet ist oder auf andere Weise vorübergehend nicht zugegriffen werden kann, wird die Anforderung nicht erfüllt.
requestSetRefreshMode(refreshMode)

Sendet eine Anforderung zum Ändern des Aktualisierungsmodus für diesen verknüpften Datentyp. Wenn der angegebene Aktualisierungsmodus von diesem verknüpften Datentyp nicht unterstützt wird, bleibt der Modus unverändert. Bei Festlegung auf "Periodisch" wird das Aktualisierungsintervall auf einen vordefinierten Wert basierend auf dem jeweiligen verknüpften Datentyp festgelegt.
requestSetRefreshMode(refreshModeString)

Sendet eine Anforderung zum Ändern des Aktualisierungsmodus für diesen verknüpften Datentyp. Wenn der angegebene Aktualisierungsmodus von diesem verknüpften Datentyp nicht unterstützt wird, bleibt der Modus unverändert. Bei Festlegung auf "Periodisch" wird das Aktualisierungsintervall auf einen vordefinierten Wert basierend auf dem jeweiligen verknüpften Datentyp festgelegt.
toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.LinkedDataType-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.LinkedDataTypeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

context

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

dataProvider

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Der Name des Datenanbieters für den verknüpften Datentyp. Dies kann sich ändern, wenn Informationen aus dem Dienst abgerufen werden.

readonly dataProvider: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

lastRefreshed

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Das Datum und die Uhrzeit der lokalen Zeitzone seit dem Öffnen der Arbeitsmappe, als der verknüpfte Datentyp zuletzt aktualisiert wurde. Gibt zurück undefined , wenn der verknüpfte Datentyp nicht aktualisiert wurde.

readonly lastRefreshed: Date;

Eigenschaftswert

Date

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

name

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Der Name des verknüpften Datentyps. Dies kann sich ändern, wenn Informationen aus dem Dienst abgerufen werden.

readonly name: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

periodicRefreshInterval

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Die Häufigkeit in Sekunden, mit der der verknüpfte Datentyp aktualisiert wird, wenn refreshMode auf "Periodisch" festgelegt ist.

readonly periodicRefreshInterval: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

refreshMode

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Der Mechanismus, mit dem die Daten für den verknüpften Datentyp abgerufen werden.

readonly refreshMode: Excel.LinkedDataTypeRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";

Eigenschaftswert

Excel.LinkedDataTypeRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

serviceId

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Die eindeutige ID des verknüpften Datentyps.

readonly serviceId: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

supportedRefreshModes

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt ein Array mit allen Aktualisierungsmodi zurück, die vom verknüpften Datentyp unterstützt werden. Der Inhalt des Arrays kann sich ändern, wenn Informationen vom Dienst abgerufen werden.

readonly supportedRefreshModes: Excel.LinkedDataTypeRefreshMode[];

Eigenschaftswert

Excel.LinkedDataTypeRefreshMode[]

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

Details zur Methode

load(options)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.LinkedDataTypeLoadOptions): Excel.LinkedDataType;

Parameter

options
Excel.Interfaces.LinkedDataTypeLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Excel.LinkedDataType

load(propertyNames)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Excel.LinkedDataType;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Excel.LinkedDataType

load(propertyNamesAndPaths)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.LinkedDataType;

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Excel.LinkedDataType

requestRefresh()

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Sendet eine Anforderung zum Aktualisieren des verknüpften Datentyps. Wenn der Dienst ausgelastet ist oder auf andere Weise vorübergehend nicht zugegriffen werden kann, wird die Anforderung nicht erfüllt.

requestRefresh(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

requestSetRefreshMode(refreshMode)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Sendet eine Anforderung zum Ändern des Aktualisierungsmodus für diesen verknüpften Datentyp. Wenn der angegebene Aktualisierungsmodus von diesem verknüpften Datentyp nicht unterstützt wird, bleibt der Modus unverändert. Bei Festlegung auf "Periodisch" wird das Aktualisierungsintervall auf einen vordefinierten Wert basierend auf dem jeweiligen verknüpften Datentyp festgelegt.

requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode): void;

Parameter

refreshMode
Excel.LinkedDataTypeRefreshMode

Der beabsichtigte Modus, in den dieser verknüpfte Datentyp geändert werden soll.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

requestSetRefreshMode(refreshModeString)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Sendet eine Anforderung zum Ändern des Aktualisierungsmodus für diesen verknüpften Datentyp. Wenn der angegebene Aktualisierungsmodus von diesem verknüpften Datentyp nicht unterstützt wird, bleibt der Modus unverändert. Bei Festlegung auf "Periodisch" wird das Aktualisierungsintervall auf einen vordefinierten Wert basierend auf dem jeweiligen verknüpften Datentyp festgelegt.

requestSetRefreshMode(refreshModeString: "Unknown" | "Manual" | "OnLoad" | "Periodic"): void;

Parameter

refreshModeString

"Unknown" | "Manual" | "OnLoad" | "Periodic"

Der beabsichtigte Modus, in den dieser verknüpfte Datentyp geändert werden soll.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

toJSON()

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.LinkedDataType-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.LinkedDataTypeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.LinkedDataTypeData;

Gibt zurück

Excel.Interfaces.LinkedDataTypeData