PowerPoint.CustomPropertyCollection class
Eine Auflistung benutzerdefinierter Eigenschaften.
- 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(key, value) | Erstellt eine neue |
| delete |
Löscht alle benutzerdefinierten Eigenschaften in dieser Sammlung. |
| get |
Ruft die Anzahl der benutzerdefinierten Eigenschaften in der Auflistung ab. |
| get |
Ruft einen |
| get |
Ruft einen |
| get |
Ruft einen |
| 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.CustomProperty[];Eigenschaftswert
Details zur Methode
add(key, value)
Erstellt eine neue CustomProperty oder aktualisiert die Eigenschaft mit dem angegebenen Schlüssel.
add(key: string, value: boolean | Date | number | string): PowerPoint.CustomProperty;Parameter
- key
-
string
Die Zeichenfolge, die das CustomProperty Objekt identifiziert. Die Groß-/Kleinschreibung wird nicht beachtet. Die maximale Schlüssellänge beträgt 255 Zeichen. Größere Zeichenfolgen führen dazu, dass der Vorgang mit einem InvalidArgument Fehler fehlschlägt.
- value
-
boolean | Date | number | string
Der Wert von CustomProperty. Wenn der Wert eine Zeichenfolge ist, beträgt die maximale Länge 255 Zeichen. Größere Zeichenfolgen führen dazu, dass der Vorgang mit einem InvalidArgument Fehler fehlschlägt.
Gibt zurück
Hinweise
deleteAll()
Löscht alle benutzerdefinierten Eigenschaften in dieser Sammlung.
deleteAll(): void;Gibt zurück
void
Hinweise
getCount()
Ruft die Anzahl der benutzerdefinierten Eigenschaften in der Auflistung ab.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Die Anzahl der benutzerdefinierten Eigenschaften in der Auflistung.
Hinweise
getItem(key)
Ruft einen CustomProperty nach seinem Schlüssel ab.
getItem(key: string): PowerPoint.CustomProperty;Parameter
- key
-
string
Die Zeichenfolge, die das CustomProperty Objekt identifiziert. Die Groß-/Kleinschreibung wird nicht beachtet. Schlüssel haben eine maximale Länge von 255 Zeichen. Wenn das Argument 255 Zeichen überschreitet, gibt diese Methode den InvalidArgument Fehler zurück.
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 CustomProperty 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.CustomProperty;Parameter
- index
-
number
Der Index der benutzerdefinierten Eigenschaft in der Auflistung.
Gibt zurück
Die benutzerdefinierte Eigenschaft am angegebenen Index.
Hinweise
getItemOrNullObject(key)
Ruft einen CustomProperty nach seinem Schlüssel ab.
CustomProperty 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(key: string): PowerPoint.CustomProperty;Parameter
- key
-
string
Die Zeichenfolge, die das CustomProperty Objekt identifiziert. Die Groß-/Kleinschreibung wird nicht beachtet. Schlüssel haben eine maximale Länge von 255 Zeichen. Wenn das Argument 255 Zeichen überschreitet, gibt diese Methode den InvalidArgument Fehler zurück.
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.CustomPropertyCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomPropertyCollection;Parameter
- options
-
PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions & 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.CustomPropertyCollection;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.CustomPropertyCollection;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.CustomPropertyCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.CustomPropertyCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.
toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData;