Excel.WorksheetCustomPropertyCollection class

Enthält die Auflistung der benutzerdefinierten Eigenschaft auf Arbeitsblattebene.

Extends

Hinweise

[API-Satz: ExcelApi 1.12 ]

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)

Fügt eine neue benutzerdefinierte Eigenschaft hinzu, die dem bereitgestellten Schlüssel zugeordnet ist. Dadurch werden vorhandene benutzerdefinierte Eigenschaften mit diesem Schlüssel überschrieben.

getCount()

Ruft die Anzahl der benutzerdefinierten Eigenschaften in diesem Arbeitsblatt ab.

getItem(key)

Ruft ein Objekt für benutzerdefinierte Eigenschaften über seinen Schlüssel ab, bei dem Groß-/Kleinschreibung nicht beachtet wird. Löst einen Fehler aus, wenn die benutzerdefinierte Eigenschaft nicht vorhanden ist.

getItemOrNullObject(key)

Ruft ein Objekt für benutzerdefinierte Eigenschaften über seinen Schlüssel ab, bei dem Groß-/Kleinschreibung nicht beachtet wird. Wenn die benutzerdefinierte Eigenschaft nicht vorhanden ist, gibt diese Funktion ein Objekt zurück, dessen isNullObject Eigenschaft auf true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften..

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 toJSON() JavaScript-Methode, um eine hilfreichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify(). (JSON.stringifyruft wiederum die Methode des Objekts auf, toJSON das an das Objekt übergeben wird.) Während das ursprüngliche Excel.WorksheetCustomPropertyCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt zurück (eingegeben als Excel.Interfaces.WorksheetCustomPropertyCollectionData), die ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

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: Excel.WorksheetCustomProperty[];

Eigenschaftswert

Details zur Methode

add(key, value)

Fügt eine neue benutzerdefinierte Eigenschaft hinzu, die dem bereitgestellten Schlüssel zugeordnet ist. Dadurch werden vorhandene benutzerdefinierte Eigenschaften mit diesem Schlüssel überschrieben.

add(key: string, value: string): Excel.WorksheetCustomProperty;

Parameter

key

string

Der Schlüssel, der das benutzerdefinierte Eigenschaftsobjekt identifiziert. Groß-/Kleinschreibung wird nicht beachtet. Der Schlüssel ist auf 255 Zeichen beschränkt (größere Werte führen dazu, dass ein InvalidArgument Fehler ausgelöst wird.)

value

string

Der Wert dieser benutzerdefinierten Eigenschaft.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.12 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml
await Excel.run(async (context) => {
  // Get the key/value pair from the task pane.
  const userKey = $("#key").text();
  const userValue = $("#value").text();

  // Add the custom property.
  const customWorksheetProperties = context.workbook.worksheets.getActiveWorksheet().customProperties;
  customWorksheetProperties.add(userKey, userValue);

  await context.sync();

  console.log(`Successfully set custom worksheet property ${userKey}:${userValue}.`);
});

getCount()

Ruft die Anzahl der benutzerdefinierten Eigenschaften in diesem Arbeitsblatt ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.12 ]

getItem(key)

Ruft ein Objekt für benutzerdefinierte Eigenschaften über seinen Schlüssel ab, bei dem Groß-/Kleinschreibung nicht beachtet wird. Löst einen Fehler aus, wenn die benutzerdefinierte Eigenschaft nicht vorhanden ist.

getItem(key: string): Excel.WorksheetCustomProperty;

Parameter

key

string

Der Schlüssel, der das benutzerdefinierte Eigenschaftsobjekt identifiziert. Groß-/Kleinschreibung wird nicht beachtet.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.12 ]

getItemOrNullObject(key)

Ruft ein Objekt für benutzerdefinierte Eigenschaften über seinen Schlüssel ab, bei dem Groß-/Kleinschreibung nicht beachtet wird. Wenn die benutzerdefinierte Eigenschaft nicht vorhanden ist, gibt diese Funktion ein Objekt zurück, dessen isNullObject Eigenschaft auf true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften..

getItemOrNullObject(key: string): Excel.WorksheetCustomProperty;

Parameter

key

string

Der Schlüssel, der das benutzerdefinierte Eigenschaftsobjekt identifiziert. Groß-/Kleinschreibung wird nicht beachtet.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.12 ]

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?: Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCustomPropertyCollection;

Parameter

options

Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Stellt Optionen bereit, für welche Eigenschaften des Objekts geladen werden soll.

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[]): Excel.WorksheetCustomPropertyCollection;

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): Excel.WorksheetCustomPropertyCollection;

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 toJSON() JavaScript-Methode, um eine hilfreichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify(). (JSON.stringifyruft wiederum die Methode des Objekts auf, toJSON das an das Objekt übergeben wird.) Während das ursprüngliche Excel.WorksheetCustomPropertyCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt zurück (eingegeben als Excel.Interfaces.WorksheetCustomPropertyCollectionData), die ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

toJSON(): Excel.Interfaces.WorksheetCustomPropertyCollectionData;

Gibt zurück