Excel.SlicerStyleCollection class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.10 ]

Свойства

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

Методы

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

items

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

readonly items: Excel.SlicerStyle[];

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

Excel.SlicerStyle[]

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

add(name, makeUniqueName)

Создает пустой стиль среза с указанным именем.

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

Параметры

name

string

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

makeUniqueName

boolean

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

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

Excel.SlicerStyle

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

Комментарии

[ Набор API: ExcelApi 1.10 ]

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: ExcelApi 1.10 ]

getDefault()

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

getDefault(): Excel.SlicerStyle;

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

Excel.SlicerStyle

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

Комментарии

[ Набор API: ExcelApi 1.10 ]

getItem(name)

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

getItem(name: string): Excel.SlicerStyle;

Параметры

name

string

Имя стиля среза, который требуется извлечь.

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

Excel.SlicerStyle

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

Комментарии

[ Набор API: ExcelApi 1.10 ]

getItemOrNullObject(name)

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

getItemOrNullObject(name: string): Excel.SlicerStyle;

Параметры

name

string

Имя стиля среза, который требуется извлечь.

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

Excel.SlicerStyle

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

Комментарии

[ Набор API: ExcelApi 1.10 ]

load(options)

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

load(options?: Excel.Interfaces.SlicerStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerStyleCollection;

Параметры

options

Excel.Interfaces.SlicerStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.SlicerStyleCollection

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.SlicerStyleCollection

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

Excel.SlicerStyleCollection

setDefault(newDefaultStyle)

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

setDefault(newDefaultStyle: SlicerStyle | string): void;

Параметры

newDefaultStyle

Excel.SlicerStyle | string

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

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

void

Комментарии

[ Набор API: ExcelApi 1.10 ]

toJSON()

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

toJSON(): Excel.Interfaces.SlicerStyleCollectionData;

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

Excel.Interfaces.SlicerStyleCollectionData