Excel.TableStyleCollection class

Пакет:

excel

Представляет коллекцию стилей таблиц.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.10 ]

Свойства

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

Методы

add(name, makeUniqueName)	Создает пустой TableStyle объект с указанным именем.
getCount()	Получает количество стилей таблиц в коллекции.
getDefault()	Возвращает стиль таблицы по умолчанию для область родительского объекта.
getItem(name)	Возвращает по TableStyle имени.
getItemOrNullObject(name)	Возвращает по TableStyle имени. Если стиль таблицы не существует, то этот метод возвращает объект со свойством isNullObject .true Дополнительные сведения см. в разделе Методы и свойства *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.TableStyleCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.TableStyleCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

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

context

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

context: RequestContext;

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

Excel.RequestContext

items

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

readonly items: Excel.TableStyle[];

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

Excel.TableStyle[]

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

add(name, makeUniqueName)

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

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

Параметры

name

string

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

makeUniqueName

boolean

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

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

Excel.TableStyle

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

Комментарии

[ Набор API: ExcelApi 1.10 ]

getCount()

Получает количество стилей таблиц в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: ExcelApi 1.10 ]

getDefault()

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

getDefault(): Excel.TableStyle;

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

Excel.TableStyle

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

Комментарии

[ Набор API: ExcelApi 1.10 ]

getItem(name)

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

getItem(name: string): Excel.TableStyle;

Параметры

name

string

Имя возвращаемого стиля таблицы.

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

Excel.TableStyle

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

Комментарии

[ Набор API: ExcelApi 1.10 ]

getItemOrNullObject(name)

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

getItemOrNullObject(name: string): Excel.TableStyle;

Параметры

name

string

Имя возвращаемого стиля таблицы.

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

Excel.TableStyle

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

Комментарии

[ Набор API: ExcelApi 1.10 ]

load(options)

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

load(options?: Excel.Interfaces.TableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableStyleCollection;

Параметры

options

Excel.Interfaces.TableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.TableStyleCollection

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.TableStyleCollection

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

Excel.TableStyleCollection

setDefault(newDefaultStyle)

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

setDefault(newDefaultStyle: TableStyle | string): void;

Параметры

newDefaultStyle

Excel.TableStyle | string

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

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

void

Комментарии

[ Набор API: ExcelApi 1.10 ]

toJSON()

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

toJSON(): Excel.Interfaces.TableStyleCollectionData;

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

Excel.Interfaces.TableStyleCollectionData