OneNote.InkWordCollection class

Stellt eine Auflistung von InkWord-Objekten dar.

[API-Satz: OneNoteApi 1.1]

Extends

Eigenschaften

context

Der Dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

count

Gibt die Anzahl von InkWords auf der Seite zurück. Schreibgeschützt.

[API-Satz: OneNoteApi 1.1]

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

Methoden

getItem(index)

Ruft ein InkWord-Objekt nach ID oder dem Index in der Auflistung ab. Schreibgeschützt.

[API-Satz: OneNoteApi 1.1]

getItemAt(index)

Ruft ein InkWord anhand seiner Position in der Auflistung ab.

[API-Satz: OneNoteApi 1.1]

load(option)

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(option)
toJSON()

Überschreibt die JavaScript-Methode, um eine nützlichere Ausgabe zu toJSON() bieten, wenn ein API-Objekt an übergeben wird JSON.stringify(). (JSON.stringifyruft wiederum die Methode toJSON des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Objekt ein API-Objekt ist, gibt die Methode OneNote.InkWordCollection toJSON ein einfaches JavaScript-Objekt zurück (typisiert als OneNote.Interfaces.InkWordCollectionData), das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

track()

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzschreibweise für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt übergreifend für ".sync"-Aufrufe und außerhalb der sequenziellen Ausführung eines ".run"-Stapels verwenden und beim Festlegen einer Eigenschaft oder Aufrufen einer Methode für das Objekt ein "InvalidObjectPath"-Fehler zurückgegeben wird, hätte das Objekt der nachverfolgten Objektsammlung hinzugefügt werden müssen, in der das Objekt ursprünglich erstellt wurde.

untrack()

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf stellt eine Kurzschreibweise für context.trackedObjects.remove(thisObject) dar. Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen "context.sync()" aufrufen, damit die Freigabe des Arbeitsspeichers wirksam wird.

Details zur Eigenschaft

context

Der Dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

count

Gibt die Anzahl von InkWords auf der Seite zurück. Schreibgeschützt.

[API-Satz: OneNoteApi 1.1]

readonly count: number;

Eigenschaftswert

number

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: OneNote.InkWord[];

Eigenschaftswert

Details zur Methode

getItem(index)

Ruft ein InkWord-Objekt nach ID oder dem Index in der Auflistung ab. Schreibgeschützt.

[API-Satz: OneNoteApi 1.1]

getItem(index: number | string): OneNote.InkWord;

Parameter

index

number | string

Die ID des InkWord-Objekts oder die Indexposition des InkWord-Objekts in der Auflistung.

Gibt zurück

getItemAt(index)

Ruft ein InkWord anhand seiner Position in der Auflistung ab.

[API-Satz: OneNoteApi 1.1]

getItemAt(index: number): OneNote.InkWord;

Parameter

index

number

Index-Wert des abzurufenden Objekts. Nullindiziert.

Gibt zurück

load(option)

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(option?: OneNote.Interfaces.InkWordCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.InkWordCollection;

Parameter

Gibt zurück

Hinweise

Zusätzlich zu dieser Signatur verfügt diese Methode über die folgenden Signaturen:

load(option?: string | string[]): OneNote.InkWordCollection - Bei der Option handelt es sich um eine durch Kommas getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

load(option?: { select?: string; expand?: string; }): OneNote.InkWordCollection - Dabei ist option.select eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und options.expand ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): OneNote.InkWordCollection - Nur für Auflistungstypen verfügbar. Sie ähnelt der vorherigen Signatur. Option.top gibt die maximale Anzahl von Auflistungselementen an, die in das Ergebnis eingeschlossen werden können. Option.skip gibt die Anzahl der Elemente an, die übersprungen und nicht in das Ergebnis einbezogen werden sollen. Wenn option.top angegeben wird, wird das Ergebnisset gestartet, nachdem die angegebene Anzahl von Elementen übersprungen wurde.

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(propertyNames?: string | string[]): OneNote.InkWordCollection;

Parameter

propertyNames

string | string[]

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

Gibt zurück

load(option)

load(option?: OfficeExtension.LoadOption): OneNote.InkWordCollection;

Parameter

Gibt zurück

toJSON()

Überschreibt die JavaScript-Methode, um eine nützlichere Ausgabe zu toJSON() bieten, wenn ein API-Objekt an übergeben wird JSON.stringify(). (JSON.stringifyruft wiederum die Methode toJSON des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Objekt ein API-Objekt ist, gibt die Methode OneNote.InkWordCollection toJSON ein einfaches JavaScript-Objekt zurück (typisiert als OneNote.Interfaces.InkWordCollectionData), das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

toJSON(): OneNote.Interfaces.InkWordCollectionData;

Gibt zurück

track()

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzschreibweise für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt übergreifend für ".sync"-Aufrufe und außerhalb der sequenziellen Ausführung eines ".run"-Stapels verwenden und beim Festlegen einer Eigenschaft oder Aufrufen einer Methode für das Objekt ein "InvalidObjectPath"-Fehler zurückgegeben wird, hätte das Objekt der nachverfolgten Objektsammlung hinzugefügt werden müssen, in der das Objekt ursprünglich erstellt wurde.

track(): OneNote.InkWordCollection;

Gibt zurück

untrack()

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf stellt eine Kurzschreibweise für context.trackedObjects.remove(thisObject) dar. Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen "context.sync()" aufrufen, damit die Freigabe des Arbeitsspeichers wirksam wird.

untrack(): OneNote.InkWordCollection;

Gibt zurück