PowerPoint.CustomXmlPartScopedCollection class
Eine bereichsbezogene Auflistung von benutzerdefinierten XML-Teilen. Eine bereichsbezogene Auflistung ist das Ergebnis eines Vorgangs (z. B. filtern nach Namespace). Eine bereichsbezogene Auflistung kann nicht weiter festgelegt werden.
- Extends
Hinweise
[ API-Satz: PowerPointApi 1.7 ]
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
get |
Ruft die Anzahl der benutzerdefinierten XML-Teile in dieser Auflistung ab. |
get |
Ruft eine |
get |
Ruft eine |
get |
Wenn die Sammlung genau ein Element enthält, gibt diese Methode es zurück. Wenn die Auflistung keine Elemente oder mehr als ein Element enthält, gibt diese Methode den |
get |
Wenn die Sammlung genau ein Element enthält, gibt diese Methode es zurück. Andernfalls gibt diese Methode 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 |
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
getCount()
Ruft die Anzahl der benutzerdefinierten XML-Teile in dieser 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
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 true
festgelegt 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
getOnlyItem()
Wenn die Sammlung genau ein Element enthält, gibt diese Methode es zurück. Wenn die Auflistung keine Elemente oder mehr als ein Element enthält, gibt diese Methode den GeneralException
Fehler zurück.
getOnlyItem(): PowerPoint.CustomXmlPart;
Gibt zurück
Hinweise
getOnlyItemOrNullObject()
Wenn die Sammlung genau ein Element enthält, gibt diese Methode es zurück. Andernfalls gibt diese Methode zurück null
.
getOnlyItemOrNullObject(): PowerPoint.CustomXmlPart;
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.CustomXmlPartScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartScopedCollection;
Parameter
- options
-
PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions & 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.CustomXmlPartScopedCollection;
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.CustomXmlPartScopedCollection;
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.stringify
ruft wiederum die toJSON
-Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche PowerPoint.CustomXmlPartScopedCollection
Objekt ein API-Objekt ist, gibt die toJSON
Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.CustomXmlPartScopedCollectionData
) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.
toJSON(): PowerPoint.Interfaces.CustomXmlPartScopedCollectionData;
Gibt zurück
Office Add-ins