Excel.TimelineStyleCollection class
Представляет коллекцию стилей временной шкалы.
- Extends
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(name, make |
Создает пустое |
| get |
Получает количество стилей временной шкалы в коллекции. |
| get |
Получает стиль временной шкалы по умолчанию для области родительского объекта. |
| get |
Получает по |
| get |
Получает по |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set |
Стиль временной шкалы по умолчанию для использования в области родительского объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Excel.TimelineStyle[];Значение свойства
Сведения о методе
add(name, makeUniqueName)
Создает пустое TimelineStyle поле с указанным именем.
add(name: string, makeUniqueName?: boolean): Excel.TimelineStyle;Параметры
- name
-
string
Уникальное имя для нового стиля временной шкалы. Выдаст ошибку, InvalidArgument если имя уже используется.
- makeUniqueName
-
boolean
Необязательный параметр. Значение по умолчанию — false. Если true, при необходимости добавит к имени цифры, чтобы сделать его уникальным.
Возвращаемое значение
Только что созданный TimelineStyleдомен .
Комментарии
getCount()
Получает количество стилей временной шкалы в коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
getDefault()
Получает стиль временной шкалы по умолчанию для области родительского объекта.
getDefault(): Excel.TimelineStyle;Возвращаемое значение
ОбъектTimelineStyle, который является текущим стилем временной шкалы по умолчанию.
Комментарии
getItem(name)
Получает по TimelineStyle имени.
getItem(name: string): Excel.TimelineStyle;Параметры
- name
-
string
Имя стиля временной шкалы, который необходимо получить.
Возвращаемое значение
Объект TimelineStyle , имя которого совпадает с именем ввода.
Комментарии
getItemOrNullObject(name)
Получает по TimelineStyle имени. Если стиля временной шкалы не существует, этот метод возвращает объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(name: string): Excel.TimelineStyle;Параметры
- name
-
string
Имя стиля временной шкалы, который необходимо получить.
Возвращаемое значение
Объект TimelineStyle , имя которого совпадает с именем ввода.
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TimelineStyleCollection;Параметры
- options
-
Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.TimelineStyleCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TimelineStyleCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
setDefault(newDefaultStyle)
Стиль временной шкалы по умолчанию для использования в области родительского объекта.
setDefault(newDefaultStyle: TimelineStyle | string): void;Параметры
- newDefaultStyle
-
Excel.TimelineStyle | string
Объект TimelineStyle или имя объекта, которое должно стать новым значением TimelineStyle по умолчанию.
Возвращаемое значение
void
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.TimelineStyleCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.TimelineStyleCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.
toJSON(): Excel.Interfaces.TimelineStyleCollectionData;