Word.XmlMapping class
Stellt die XML-Zuordnung auf einem Word dar. ContentControl-Objekt zwischen benutzerdefiniertem XML und diesem Inhaltssteuerelement. Eine XML-Zuordnung ist eine Verknüpfung zwischen dem Text in einem Inhaltssteuerelement und einem XML-Element im benutzerdefinierten XML-Datenspeicher für dieses Dokument.
- 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. |
| custom |
Gibt ein |
| custom |
Gibt ein |
| is |
Gibt zurück, ob das Inhaltssteuerelement im Dokument einem XML-Knoten im XML-Datenspeicher des Dokuments zugeordnet ist. |
| prefix |
Gibt die Präfixzuordnungen zurück, die zum Auswerten des XPath für die aktuelle XML-Zuordnung verwendet werden. |
| xpath | Gibt den XPath für die XML-Zuordnung zurück, der dem aktuell zugeordneten XML-Knoten ausgewertet wird. |
Methoden
| delete() | Löscht die XML-Zuordnung aus dem übergeordneten Inhaltssteuerelement. |
| 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 " |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| set |
Ermöglicht das Erstellen oder Ändern der XML-Zuordnung für das Inhaltssteuerelement. |
| set |
Ermöglicht das Erstellen oder Ändern der XML-Datenzuordnung im Inhaltssteuerelement. |
| 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 |
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
customXmlNode
Gibt ein CustomXmlNode -Objekt zurück, das den benutzerdefinierten XML-Knoten im Datenspeicher darstellt, dem das Inhaltssteuerelement im Dokument zugeordnet ist.
readonly customXmlNode: Word.CustomXmlNode;Eigenschaftswert
Hinweise
customXmlPart
Gibt ein CustomXmlPart -Objekt zurück, das den benutzerdefinierten XML-Teil darstellt, dem das Inhaltssteuerelement im Dokument zugeordnet ist.
readonly customXmlPart: Word.CustomXmlPart;Eigenschaftswert
Hinweise
isMapped
Gibt zurück, ob das Inhaltssteuerelement im Dokument einem XML-Knoten im XML-Datenspeicher des Dokuments zugeordnet ist.
readonly isMapped: boolean;Eigenschaftswert
boolean
Hinweise
prefixMappings
Gibt die Präfixzuordnungen zurück, die zum Auswerten des XPath für die aktuelle XML-Zuordnung verwendet werden.
readonly prefixMappings: string;Eigenschaftswert
string
Hinweise
xpath
Gibt den XPath für die XML-Zuordnung zurück, der dem aktuell zugeordneten XML-Knoten ausgewertet wird.
readonly xpath: string;Eigenschaftswert
string
Hinweise
Details zur Methode
delete()
Löscht die XML-Zuordnung aus dem übergeordneten Inhaltssteuerelement.
delete(): void;Gibt zurück
void
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.XmlMappingLoadOptions): Word.XmlMapping;Parameter
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.XmlMapping;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?: {
select?: string;
expand?: string;
}): Word.XmlMapping;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
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.XmlMappingUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Word.Interfaces.XmlMappingUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Word.XmlMapping): void;Parameter
- properties
- Word.XmlMapping
Gibt zurück
void
setMapping(xPath, options)
Ermöglicht das Erstellen oder Ändern der XML-Zuordnung für das Inhaltssteuerelement.
setMapping(xPath: string, options?: Word.XmlSetMappingOptions): OfficeExtension.ClientResult<boolean>;Parameter
- xPath
-
string
Der auszuwertende XPath-Ausdruck.
- options
- Word.XmlSetMappingOptions
Optional. Die verfügbaren Optionen zum Festlegen der XML-Zuordnung.
Gibt zurück
OfficeExtension.ClientResult<boolean>
Hinweise
setMappingByNode(node)
Ermöglicht das Erstellen oder Ändern der XML-Datenzuordnung im Inhaltssteuerelement.
setMappingByNode(node: Word.CustomXmlNode): OfficeExtension.ClientResult<boolean>;Parameter
- node
- Word.CustomXmlNode
Der zuzuordnende benutzerdefinierte XML-Knoten.
Gibt zurück
OfficeExtension.ClientResult<boolean>
Hinweise
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.XmlMapping Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.XmlMappingData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Word.Interfaces.XmlMappingData;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.XmlMapping;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.XmlMapping;