Word.CustomXmlSchemaCollection class
Stellt eine Auflistung von Word dar. CustomXmlSchema-Objekte, die an einen Datenstrom angefügt sind.
- Extends
Hinweise
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. |
Methoden
| add(options) | Fügt der Schemaauflistung ein oder mehrere Schemas hinzu, die dann einem Stream im Datenspeicher und der Schemabibliothek hinzugefügt werden können. |
| add |
Fügt der aktuellen Schemaauflistung eine vorhandene Schemaauflistung hinzu. |
| get |
Gibt die Anzahl der Elemente in der Auflistung zurück. |
| get |
Gibt ein |
| get |
Gibt die Anzahl der Elemente in der Auflistung zurück. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| toJSON() | Überschreibt die JavaScript-Methode |
| track() | Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über |
| untrack() | Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen |
| validate() | Gibt an, ob die Schemas in der Schemaauflistung gültig sind (entspricht den syntaktischen Regeln von XML und den Regeln für ein angegebenes Vokabular). |
Details zur Eigenschaft
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: Word.CustomXmlSchema[];Eigenschaftswert
Details zur Methode
add(options)
Fügt der Schemaauflistung ein oder mehrere Schemas hinzu, die dann einem Stream im Datenspeicher und der Schemabibliothek hinzugefügt werden können.
add(options?: Word.CustomXmlAddSchemaOptions): Word.CustomXmlSchema;Parameter
- options
- Word.CustomXmlAddSchemaOptions
Optional. Die Optionen, die das hinzuzufügende Schema definieren.
Gibt zurück
Hinweise
addCollection(schemaCollection)
Fügt der aktuellen Schemaauflistung eine vorhandene Schemaauflistung hinzu.
addCollection(schemaCollection: Word.CustomXmlSchemaCollection): Word.CustomXmlSchemaCollection;Parameter
- schemaCollection
- Word.CustomXmlSchemaCollection
Die hinzuzufügende Schemaauflistung.
Gibt zurück
Hinweise
getCount()
Gibt die Anzahl der Elemente in der Auflistung zurück.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
getItem(index)
Gibt ein CustomXmlSchema -Objekt zurück, das das angegebene Element in der Auflistung darstellt.
getItem(index: number): Word.CustomXmlSchema;Parameter
- index
-
number
Die Position eines CustomXmlSchema Objekts.
Gibt zurück
Hinweise
getNamespaceUri()
Gibt die Anzahl der Elemente in der Auflistung zurück.
getNamespaceUri(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
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(options?: Word.Interfaces.CustomXmlSchemaCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlSchemaCollection;Parameter
- options
-
Word.Interfaces.CustomXmlSchemaCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
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[]): Word.CustomXmlSchemaCollection;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
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.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlSchemaCollection;Parameter
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
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 Word.CustomXmlSchemaCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.CustomXmlSchemaCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.
toJSON(): Word.Interfaces.CustomXmlSchemaCollectionData;Gibt zurück
track()
Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.
track(): Word.CustomXmlSchemaCollection;Gibt zurück
untrack()
Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.CustomXmlSchemaCollection;Gibt zurück
validate()
Gibt an, ob die Schemas in der Schemaauflistung gültig sind (entspricht den syntaktischen Regeln von XML und den Regeln für ein angegebenes Vokabular).
validate(): OfficeExtension.ClientResult<boolean>;Gibt zurück
OfficeExtension.ClientResult<boolean>