Excel.TimelineStyleCollection interface

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

Методы

add(name, makeUniqueName)

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

getCount()

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

getDefault()

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

getItem(name)

Получает объект TimelineStyle по имени.

getItemOrNullObject(name)

Получает объект TimelineStyle по имени. Если объект TimelineStyle не существует, возвращает пустой объект.

load(propertyNames)

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

setDefault(newDefaultStyle)

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

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

add(name, makeUniqueName)

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

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

Параметры

name
string

Уникальное имя нового Тимелинестиле. Если имя уже используется, будет выдаваться исключение недопустимого аргумента.

makeUniqueName
boolean

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

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

getCount()

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

getCount(): ClientResult<number>;

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

ClientResult<number>

getDefault()

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

getDefault(): TimelineStyle;

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

getItem(name)

Получает объект TimelineStyle по имени.

getItem(name: string): TimelineStyle;

Параметры

name
string

Имя извлекаемого Тимелинестиле.

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

getItemOrNullObject(name)

Получает объект TimelineStyle по имени. Если объект TimelineStyle не существует, возвращает пустой объект.

getItemOrNullObject(name: string): TimelineStyle;

Параметры

name
string

Имя извлекаемого Тимелинестиле.

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

load(propertyNames)

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

load(propertyNames?: string | string[]): void;

Параметры

propertyNames
string | string[]

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

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

void

setDefault(newDefaultStyle)

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

setDefault(newDefaultStyle: TimelineStyle | string): void;

Параметры

newDefaultStyle
TimelineStyle | string

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

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

void