Excel.TimelineStyleCollection class

Пакет:

excel

Представляет коллекцию стилей временной шкалы.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.10 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
items	Получает загруженные дочерние элементы в этой коллекции.

Методы

add(name, makeUniqueName)	Создает пустой TimelineStyle объект с указанным именем.
getCount()	Получает количество стилей временной шкалы в коллекции.
getDefault()	Возвращает стиль временной шкалы по умолчанию для области родительского объекта.
getItem(name)	Возвращает по TimelineStyle имени.
getItemOrNullObject(name)	Возвращает по TimelineStyle имени. Если стиль временной шкалы не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
setDefault(newDefaultStyle)	Задает стиль временной шкалы по умолчанию для использования в области родительского объекта.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.TimelineStyleCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.TimelineStyleCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Excel.TimelineStyle[];

Значение свойства

Excel.TimelineStyle[]

Сведения о методе

add(name, makeUniqueName)

Создает пустой TimelineStyle объект с указанным именем.

add(name: string, makeUniqueName?: boolean): Excel.TimelineStyle;

Параметры

name

string

Уникальное имя нового стиля временной шкалы. Если имя уже используется, вызовет InvalidArgument ошибку.

makeUniqueName

boolean

Необязательный параметр. По умолчанию используется значение false. Если trueзначение , при необходимости добавит к имени номера, чтобы сделать его уникальным.

Возвращаемое значение

Excel.TimelineStyle

Только что созданный TimelineStyleобъект .

Комментарии

[ Набор API: ExcelApi 1.10 ]

getCount()

Получает количество стилей временной шкалы в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

Возвращаемое значение

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: ExcelApi 1.10 ]

getDefault()

Возвращает стиль временной шкалы по умолчанию для области родительского объекта.

getDefault(): Excel.TimelineStyle;

Возвращаемое значение

Excel.TimelineStyle

Объект TimelineStyle , который является текущим стилем временной шкалы по умолчанию.

Комментарии

[ Набор API: ExcelApi 1.10 ]

getItem(name)

Возвращает по TimelineStyle имени.

getItem(name: string): Excel.TimelineStyle;

Параметры

name

string

Имя извлекаемого стиля временной шкалы.

Возвращаемое значение

Excel.TimelineStyle

Объект TimelineStyle , имя которого соответствует входным данным.

Комментарии

[ Набор API: ExcelApi 1.10 ]

getItemOrNullObject(name)

Возвращает по TimelineStyle имени. Если стиль временной шкалы не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(name: string): Excel.TimelineStyle;

Параметры

name

string

Имя извлекаемого стиля временной шкалы.

Возвращаемое значение

Excel.TimelineStyle

Объект TimelineStyle , имя которого соответствует входным данным.

Комментарии

[ Набор API: ExcelApi 1.10 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TimelineStyleCollection;

Параметры

options

Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Excel.TimelineStyleCollection

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.TimelineStyleCollection;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Excel.TimelineStyleCollection

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TimelineStyleCollection;

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Excel.TimelineStyleCollection

setDefault(newDefaultStyle)

Задает стиль временной шкалы по умолчанию для использования в области родительского объекта.

setDefault(newDefaultStyle: TimelineStyle | string): void;

Параметры

newDefaultStyle

Excel.TimelineStyle | string

Объект TimelineStyle или имя TimelineStyle объекта, который должен быть новым значением по умолчанию.

Возвращаемое значение

void

Комментарии

[ Набор API: ExcelApi 1.10 ]

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.TimelineStyleCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.TimelineStyleCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

toJSON(): Excel.Interfaces.TimelineStyleCollectionData;

Возвращаемое значение

Excel.Interfaces.TimelineStyleCollectionData