Excel.TimelineStyleCollection class
Represents a collection of timeline styles.
- Extends
Remarks
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| items | Gets the loaded child items in this collection. |
Methods
| add(name, make |
Creates a blank |
| get |
Gets the number of timeline styles in the collection. |
| get |
Gets the default timeline style for the parent object's scope. |
| get |
Gets a |
| get |
Gets a |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| set |
Sets the default timeline style for use in the parent object's scope. |
| toJSON() | Overrides the JavaScript |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
items
Gets the loaded child items in this collection.
readonly items: Excel.TimelineStyle[];Property Value
Method Details
add(name, makeUniqueName)
Creates a blank TimelineStyle with the specified name.
add(name: string, makeUniqueName?: boolean): Excel.TimelineStyle;Parameters
- name
-
string
The unique name for the new timeline style. Will throw an InvalidArgument error if the name is already in use.
- makeUniqueName
-
boolean
Optional. Defaults to false. If true, will append numbers to the name in order to make it unique, if needed.
Returns
The newly created TimelineStyle.
Remarks
getCount()
Gets the number of timeline styles in the collection.
getCount(): OfficeExtension.ClientResult<number>;Returns
OfficeExtension.ClientResult<number>
Remarks
getDefault()
Gets the default timeline style for the parent object's scope.
getDefault(): Excel.TimelineStyle;Returns
The TimelineStyle object that is the current default timeline style.
Remarks
getItem(name)
Gets a TimelineStyle by name.
getItem(name: string): Excel.TimelineStyle;Parameters
- name
-
string
Name of the timeline style to be retrieved.
Returns
The TimelineStyle object whose name matches the input.
Remarks
getItemOrNullObject(name)
Gets a TimelineStyle by name. If the timeline style doesn't exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getItemOrNullObject(name: string): Excel.TimelineStyle;Parameters
- name
-
string
Name of the timeline style to be retrieved.
Returns
The TimelineStyle object whose name matches the input.
Remarks
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TimelineStyleCollection;Parameters
- options
-
Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.TimelineStyleCollection;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TimelineStyleCollection;Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
setDefault(newDefaultStyle)
Sets the default timeline style for use in the parent object's scope.
setDefault(newDefaultStyle: TimelineStyle | string): void;Parameters
- newDefaultStyle
-
Excel.TimelineStyle | string
The TimelineStyle object, or name of the TimelineStyle object, that should be the new default.
Returns
void
Remarks
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.TimelineStyleCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.TimelineStyleCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Excel.Interfaces.TimelineStyleCollectionData;