Excel.GroupShapeCollection class

Stellt die Shape-Auflistung innerhalb einer Formgruppe dar.

Extends

Hinweise

[API-Satz: ExcelApi 1.9 ]

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

getCount()

Gibt die Anzahl der Formen in der Formgruppe zurück.

getItem(key)

Ruft ein Shape anhand seines Namens oder seiner ID ab.

getItemAt(index)

Ruft eine Form anhand ihrer Position in der Auflistung ab.

getItemOrNullObject(key)

Ruft ein Shape anhand seines Namens oder seiner ID ab. Wenn das Shape-Objekt 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.GroupShapeCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt zurück (typisiert als Excel.Interfaces.GroupShapeCollectionData), 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.Shape[];

Eigenschaftswert

Details zur Methode

getCount()

Gibt die Anzahl der Formen in der Formgruppe zurück.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9 ]

getItem(key)

Ruft ein Shape anhand seines Namens oder seiner ID ab.

getItem(key: string): Excel.Shape;

Parameter

key

string

Der Name oder die ID des abzurufenden Shapes.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9 ]

getItemAt(index)

Ruft eine Form anhand ihrer Position in der Auflistung ab.

getItemAt(index: number): Excel.Shape;

Parameter

index

number

Der nullbasierte Indexwert des abzurufenden Objekts.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9 ]

getItemOrNullObject(key)

Ruft ein Shape anhand seines Namens oder seiner ID ab. Wenn das Shape-Objekt 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.Shape;

Parameter

key

string

Der Name oder die ID des abzurufenden Shapes.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.14 ]

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.GroupShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.GroupShapeCollection;

Parameter

options

Excel.Interfaces.GroupShapeCollectionLoadOptions & 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.GroupShapeCollection;

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

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.GroupShapeCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt zurück (typisiert als Excel.Interfaces.GroupShapeCollectionData), die ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

toJSON(): Excel.Interfaces.GroupShapeCollectionData;

Gibt zurück