Поделиться через


Excel.ConditionalRangeBorderCollection class

Представляет объекты границ, из которых состоит граница диапазона.

Extends

Комментарии

[ Набор API: ExcelApi 1.6 ]

Свойства

bottom

Возвращает нижнюю границу.

context

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

count

Количество объектов границы в коллекции.

items

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

left

Возвращает левую границу.

right

Возвращает правильную границу.

top

Возвращает верхнюю границу.

Методы

getItem(index)

Возвращает объект границы по его имени.

getItem(indexString)

Возвращает объект границы по его имени.

getItemAt(index)

Возвращает объект границы по его индексу.

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

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

bottom

Возвращает нижнюю границу.

readonly bottom: Excel.ConditionalRangeBorder;

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

Комментарии

[ Набор API: ExcelApi 1.6 ]

context

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

context: RequestContext;

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

count

Количество объектов границы в коллекции.

readonly count: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.6 ]

items

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

readonly items: Excel.ConditionalRangeBorder[];

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

left

Возвращает левую границу.

readonly left: Excel.ConditionalRangeBorder;

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

Комментарии

[ Набор API: ExcelApi 1.6 ]

right

Возвращает правильную границу.

readonly right: Excel.ConditionalRangeBorder;

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

Комментарии

[ Набор API: ExcelApi 1.6 ]

top

Возвращает верхнюю границу.

readonly top: Excel.ConditionalRangeBorder;

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

Комментарии

[ Набор API: ExcelApi 1.6 ]

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

getItem(index)

Возвращает объект границы по его имени.

getItem(index: Excel.ConditionalRangeBorderIndex): Excel.ConditionalRangeBorder;

Параметры

index
Excel.ConditionalRangeBorderIndex

Значение индекса получаемого объекта границы. Дополнительные сведения см. в этой Excel.ConditionalRangeBorderIndex статье.

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

Комментарии

[ Набор API: ExcelApi 1.6 ]

getItem(indexString)

Возвращает объект границы по его имени.

getItem(indexString: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"): Excel.ConditionalRangeBorder;

Параметры

indexString

"EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"

Значение индекса получаемого объекта границы. Дополнительные сведения см. в этой Excel.ConditionalRangeBorderIndex статье.

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

Комментарии

[ Набор API: ExcelApi 1.6 ]

getItemAt(index)

Возвращает объект границы по его индексу.

getItemAt(index: number): Excel.ConditionalRangeBorder;

Параметры

index

number

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

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

Комментарии

[ Набор API: ExcelApi 1.6 ]

load(options)

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

load(options?: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalRangeBorderCollection;

Параметры

options

Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths
OfficeExtension.LoadOption

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

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

toJSON()

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

toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData;

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