Excel.TimelineStyleCollection class
Stellt eine Auflistung von Zeitleiste Formatvorlagen dar.
- Extends
Hinweise
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. 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 einen leeren |
| get |
Ruft die Anzahl der Zeitachsen-Formatvorlagen in der Sammlung ab. |
| get |
Ruft die Standardformatvorlage Zeitleiste für den Bereich des übergeordneten Objekts ab. |
| get |
Ruft einen |
| get |
Ruft einen |
| 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 die Standardformatvorlage Zeitleiste fest, die im Bereich des übergeordneten Objekts verwendet werden soll. |
| toJSON() | Überschreibt die JavaScript-Methode |
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
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: Excel.TimelineStyle[];Eigenschaftswert
Details zur Methode
add(name, makeUniqueName)
Erstellt einen leeren TimelineStyle mit dem angegebenen Namen.
add(name: string, makeUniqueName?: boolean): Excel.TimelineStyle;Parameter
- name
-
string
Der eindeutige Name für die neue Zeitleiste Formatvorlage. Löst einen Fehler aus InvalidArgument , wenn der Name bereits verwendet wird.
- makeUniqueName
-
boolean
Optional. Der Standardwert ist false. Bei truefügt bei Bedarf Zahlen an den Namen an, um ihn eindeutig zu machen.
Gibt zurück
Die 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 Standardformatvorlage Zeitleiste für den Bereich des übergeordneten Objekts ab.
getDefault(): Excel.TimelineStyle;Gibt zurück
Das TimelineStyle Objekt, das die aktuelle Standardformatvorlage Zeitleiste ist.
Hinweise
getItem(name)
Ruft einen TimelineStyle anhand des Namens ab.
getItem(name: string): Excel.TimelineStyle;Parameter
- name
-
string
Der Name des abzurufenden Zeitleiste Stils.
Gibt zurück
Das TimelineStyle Objekt, dessen Name mit der Eingabe übereinstimmt.
Hinweise
getItemOrNullObject(name)
Ruft einen TimelineStyle anhand des Namens ab. Wenn die Zeitleiste-Formatvorlage nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getItemOrNullObject(name: string): Excel.TimelineStyle;Parameter
- name
-
string
Der Name des abzurufenden Zeitleiste Stils.
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 dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
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 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
setDefault(newDefaultStyle)
Legt die Standardformatvorlage Zeitleiste fest, die im Bereich des übergeordneten Objekts verwendet werden soll.
setDefault(newDefaultStyle: TimelineStyle | string): void;Parameter
- newDefaultStyle
-
Excel.TimelineStyle | string
Das TimelineStyle Objekt oder der Name des TimelineStyle Objekts, das die neue Standardeinstellung sein sollte.
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 das Objekt ü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 Auflistung enthält.
toJSON(): Excel.Interfaces.TimelineStyleCollectionData;Gibt zurück
Office Add-ins