PowerPoint.CustomXmlPartCollection class
Eine Auflistung von benutzerdefinierten XML-Teilen.
- 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(xml) | Fügt der Auflistung ein neues |
| get |
Ruft eine neue bereichsbezogene Sammlung von benutzerdefinierten XML-Komponenten ab, deren Namespaces dem angegebenen Namespace entsprechen. |
| get |
Ruft die Anzahl der benutzerdefinierten XML-Teile in der Auflistung ab. |
| get |
Ruft eine |
| get |
Ruft einen |
| get |
Ruft eine |
| 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 |
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: PowerPoint.CustomXmlPart[];Eigenschaftswert
Details zur Methode
add(xml)
Fügt der Auflistung ein neues CustomXmlPart hinzu.
add(xml: string): PowerPoint.CustomXmlPart;Parameter
- xml
-
string
XML-Inhalt. Muss ein gültiges XML-Fragment sein. Wenn das XML-Fragment ungültig ist, gibt diese Methode den GeneralException Fehler zurück.
Gibt zurück
Hinweise
getByNamespace(namespaceUri)
Ruft eine neue bereichsbezogene Sammlung von benutzerdefinierten XML-Komponenten ab, deren Namespaces dem angegebenen Namespace entsprechen.
getByNamespace(namespaceUri: string): PowerPoint.CustomXmlPartScopedCollection;Parameter
- namespaceUri
-
string
Hierbei muss es sich um einen vollqualifizierten Schema-URI handeln, z. B. "http://schemas.contoso.com/review/1.0"".
Gibt zurück
Hinweise
getCount()
Ruft die Anzahl der benutzerdefinierten XML-Teile in der Auflistung ab.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Die Anzahl der benutzerdefinierten XML-Teile in der Auflistung.
Hinweise
getItem(id)
Ruft eine CustomXmlPart basierend auf seiner ID ab.
getItem(id: string): PowerPoint.CustomXmlPart;Parameter
- id
-
string
ID des abzurufenden Objekts.
Gibt zurück
Hinweise
getItemAt(index)
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.
Ruft einen CustomXmlPart nach seinem nullbasierten Index in der Auflistung ab. Löst eine Ausnahme aus InvalidArgument , wenn sich der Index außerhalb des zulässigen Bereichs befindet.
getItemAt(index: number): PowerPoint.CustomXmlPart;Parameter
- index
-
number
Der Index des benutzerdefinierten XML-Teils in der Auflistung.
Gibt zurück
Die benutzerdefinierte XML-Komponente am angegebenen Index.
Hinweise
getItemOrNullObject(id)
Ruft eine CustomXmlPart basierend auf seiner ID ab.
CustomXmlPart Wenn nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;Parameter
- id
-
string
ID des abzurufenden Objekts.
Gibt zurück
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?: PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartCollection;Parameter
- options
-
PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions & PowerPoint.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[]): PowerPoint.CustomXmlPartCollection;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): PowerPoint.CustomXmlPartCollection;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 PowerPoint.CustomXmlPartCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.CustomXmlPartCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.
toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;