PowerPoint.CustomPropertyCollection class
Eine Auflistung benutzerdefinierter Eigenschaften.
- Extends
Eigenschaften
| context | Der dem Objekt zugeordnete Anforderungskontext. 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 einen neuen |
| delete |
Löscht alle benutzerdefinierten Eigenschaften in dieser Sammlung. |
| get |
Ruft die Anzahl der benutzerdefinierten Eigenschaften in der Auflistung ab. |
| get |
Ruft einen nach |
| get |
Ruft einen anhand |
| get |
Ruft einen nach |
| 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 dem Objekt zugeordnete Anforderungskontext. 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 einen neuen CustomProperty Schlüssel 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. Groß- und 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 der 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 Sammlung.
Hinweise
getItem(key)
Ruft einen nach CustomProperty Schlüssel ab.
getItem(key: string): PowerPoint.CustomProperty;Parameter
- key
-
string
Die Zeichenfolge, die das CustomProperty Objekt identifiziert. Groß- und Kleinschreibung wird nicht beachtet. Schlüssel haben eine maximale Länge von 255 Zeichen. Wenn das Argument mehr als 255 Zeichen enthält, gibt diese Methode den InvalidArgument Fehler zurück.
Gibt zurück
Hinweise
getItemAt(index)
Ruft einen anhand CustomProperty seines nullbasierten Indexes in der Auflistung ab. Löst eine InvalidArgument Ausnahme aus, wenn der Index außerhalb des zulässigen Bereichs liegt.
getItemAt(index: number): PowerPoint.CustomProperty;Parameter
- index
-
number
Der Index der benutzerdefinierten Eigenschaft in der Sammlung.
Gibt zurück
Die benutzerdefinierte Eigenschaft am angegebenen Index.
Hinweise
getItemOrNullObject(key)
Ruft einen nach CustomProperty Schlüssel ab. Wenn das CustomProperty nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getItemOrNullObject(key: string): PowerPoint.CustomProperty;Parameter
- key
-
string
Die Zeichenfolge, die das CustomProperty Objekt identifiziert. Groß- und Kleinschreibung wird nicht beachtet. Schlüssel haben eine maximale Länge von 255 Zeichen. Wenn das Argument mehr als 255 Zeichen enthält, 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 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[]): 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 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
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 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 Sammlung enthält.
toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData;