Excel.TimelineStyleCollection class
Stellt eine Sammlung von Formatvorlagen für die Zeitleiste dar.
- 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(name, make |
Erstellt ein leeres Zeichen |
| get |
Ruft die Anzahl der Zeitachsen-Formatvorlagen in der Sammlung ab. |
| get |
Ruft die standardmäßige Zeitleiste für den Bereich des übergeordneten Objekts ab. |
| get |
Ruft A |
| get |
Ruft A |
| 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 " |
| set |
Legt den Standardstil der Zeitleiste für die Verwendung im Bereich des übergeordneten Objekts fest. |
| 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: Excel.TimelineStyle[];Eigenschaftswert
Details zur Methode
add(name, makeUniqueName)
Erstellt ein leeres Zeichen TimelineStyle mit dem angegebenen Namen.
add(name: string, makeUniqueName?: boolean): Excel.TimelineStyle;Parameter
- name
-
string
Der eindeutige Name für die neue Zeitleiste. Gibt einen InvalidArgument Fehler aus, wenn der Name bereits verwendet wird.
- makeUniqueName
-
boolean
Optional. Der Standardwert ist false. If true, hängt Nummern an den Namen an, um ihn bei Bedarf eindeutig zu machen.
Gibt zurück
Das neu erstellte TimelineStyle.
Hinweise
getCount()
Ruft die Anzahl der Zeitachsen-Formatvorlagen in der Sammlung ab.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
getDefault()
Ruft die standardmäßige Zeitleiste für den Bereich des übergeordneten Objekts ab.
getDefault(): Excel.TimelineStyle;Gibt zurück
Das TimelineStyle Objekt, das die aktuelle Standardart der Zeitleiste ist.
Hinweise
getItem(name)
Ruft A TimelineStyle nach Name ab.
getItem(name: string): Excel.TimelineStyle;Parameter
- name
-
string
Name der Zeitleiste, die abgerufen werden soll.
Gibt zurück
Das TimelineStyle Objekt, dessen Name mit der Eingabe übereinstimmt.
Hinweise
getItemOrNullObject(name)
Ruft A TimelineStyle nach Name ab. Wenn die Zeitleiste nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt isttrue. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getItemOrNullObject(name: string): Excel.TimelineStyle;Parameter
- name
-
string
Name der Zeitleiste, die abgerufen werden soll.
Gibt zurück
Das TimelineStyle Objekt, dessen Name mit der Eingabe übereinstimmt.
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?: Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TimelineStyleCollection;Parameter
- options
-
Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.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[]): Excel.TimelineStyleCollection;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.TimelineStyleCollection;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
setDefault(newDefaultStyle)
Legt den Standardstil der Zeitleiste für die Verwendung im Bereich des übergeordneten Objekts fest.
setDefault(newDefaultStyle: TimelineStyle | string): void;Parameter
- newDefaultStyle
-
Excel.TimelineStyle | string
Das TimelineStyle Objekt oder der Name des TimelineStyle Objekts, das der neue Standard sein soll.
Gibt zurück
void
Hinweise
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 Excel.TimelineStyleCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.TimelineStyleCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.
toJSON(): Excel.Interfaces.TimelineStyleCollectionData;