Excel.CustomXmlPart class
Stellt ein benutzerdefiniertes XML-Teilobjekt in einer Arbeitsmappe dar.
- Extends
Hinweise
[API-Satz: ExcelApi 1.5]
Eigenschaften
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| id | Die ID des benutzerdefinierten XML-Teils. |
| namespace |
Der Namespace-URI des benutzerdefinierten XML-Teils. |
Methoden
| delete() | Löscht die benutzerdefinierte XML-Komponente. |
| get |
Ruft den vollständigen XML-Inhalt der benutzerdefinierten XML-Komponente ab. |
| 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 |
Legt den vollständigen XML-Inhalt der benutzerdefinierten XML-Komponente fest. |
| toJSON() | Überschreibt die JavaScript-Methode |
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
id
Die ID des benutzerdefinierten XML-Teils.
readonly id: string;Eigenschaftswert
string
Hinweise
[API-Satz: ExcelApi 1.5]
namespaceUri
Der Namespace-URI des benutzerdefinierten XML-Teils.
readonly namespaceUri: string;Eigenschaftswert
string
Hinweise
[API-Satz: ExcelApi 1.5]
Details zur Methode
delete()
Löscht die benutzerdefinierte XML-Komponente.
delete(): void;Gibt zurück
void
Hinweise
[API-Satz: ExcelApi 1.5]
getXml()
Ruft den vollständigen XML-Inhalt der benutzerdefinierten XML-Komponente ab.
getXml(): OfficeExtension.ClientResult<string>;Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
[API-Satz: ExcelApi 1.5]
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?: Excel.Interfaces.CustomXmlPartLoadOptions): Excel.CustomXmlPart;Parameter
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
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[]): Excel.CustomXmlPart;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;
}): Excel.CustomXmlPart;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
setXml(xml)
Legt den vollständigen XML-Inhalt der benutzerdefinierten XML-Komponente fest.
setXml(xml: string): void;Parameter
- xml
-
string
XML-Inhalt für das Webpart anzugeben.
Gibt zurück
void
Hinweise
[API-Satz: ExcelApi 1.5]
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 sie übergeben wird.) Während das ursprüngliche Excel.CustomXmlPart Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.CustomXmlPartData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Excel.Interfaces.CustomXmlPartData;