PowerPoint.CustomProperty class

Paket:

powerpoint

Stellt eine benutzerdefinierte Eigenschaft dar.

Extends

OfficeExtension.ClientObject

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.
key	Die Zeichenfolge, die die benutzerdefinierte Eigenschaft eindeutig identifiziert.
type	Der Typ des Werts, der für die benutzerdefinierte Eigenschaft verwendet wird.
value	Der Wert der benutzerdefinierten Eigenschaft. 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.

Methoden

delete()	Löscht die benutzerdefinierte Eigenschaft.
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(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(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.
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.CustomProperty Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.CustomPropertyData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

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

PowerPoint.RequestContext

key

Die Zeichenfolge, die die benutzerdefinierte Eigenschaft eindeutig identifiziert.

readonly key: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: PowerPointApi 1.7 ]

type

Der Typ des Werts, der für die benutzerdefinierte Eigenschaft verwendet wird.

readonly type: PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String";

Eigenschaftswert

PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String"

Hinweise

[ API-Satz: PowerPointApi 1.7 ]

value

Der Wert der benutzerdefinierten Eigenschaft. 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.

value: boolean | Date | number | string;

Eigenschaftswert

boolean | Date | number | string

Hinweise

[ API-Satz: PowerPointApi 1.7 ]

Details zur Methode

delete()

Löscht die benutzerdefinierte Eigenschaft.

delete(): void;

Gibt zurück

void

Hinweise

[ API-Satz: PowerPointApi 1.7 ]

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.CustomPropertyLoadOptions): PowerPoint.CustomProperty;

Parameter

options

PowerPoint.Interfaces.CustomPropertyLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

PowerPoint.CustomProperty

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.CustomProperty;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

PowerPoint.CustomProperty

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;
        }): PowerPoint.CustomProperty;

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

PowerPoint.CustomProperty

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.CustomProperty Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.CustomPropertyData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): PowerPoint.Interfaces.CustomPropertyData;

Gibt zurück

PowerPoint.Interfaces.CustomPropertyData