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

Excel.RangeBorderCollection class

  • Ссылка
Пакет:
excel

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

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

context

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

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

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

Задает двойник, который осветляет или затемняет цвет границ диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. null Значение указывает, что вся коллекция границ не имеет единообразного tintAndShade параметра.

Методы

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.RangeBorderCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.RangeBorderCollectionData), который содержит массив "items" с неглубокими копиями всех загруженных свойств из элементов коллекции.

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

context

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

context: RequestContext;

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

Excel.RequestContext

count

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

readonly count: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.1 ]

items

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

readonly items: Excel.RangeBorder[];

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

Excel.RangeBorder[]

tintAndShade

Задает двойник, который осветляет или затемняет цвет границ диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. null Значение указывает, что вся коллекция границ не имеет единообразного tintAndShade параметра.

tintAndShade: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

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

getItem(index)

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

getItem(index: Excel.BorderIndex): Excel.RangeBorder;

Параметры

index
Excel.BorderIndex

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

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

Excel.RangeBorder

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const border = range.format.borders.getItem(Excel.BorderIndex.edgeTop);
    border.load('style');
    await context.sync();

    console.log(border.style);
});

getItem(indexString)

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

getItem(indexString: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"): Excel.RangeBorder;

Параметры

indexString

"EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"

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

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

Excel.RangeBorder

Комментарии

[ Набор API: ExcelApi 1.1 ]

getItemAt(index)

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

getItemAt(index: number): Excel.RangeBorder;

Параметры

index

number

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

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

Excel.RangeBorder

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const border = range.format.borders.getItemAt(0);
    border.load('sideIndex');
    await context.sync();
    
    console.log(border.sideIndex);
});

load(options)

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

load(options?: Excel.Interfaces.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeBorderCollection;

Параметры

options

Excel.Interfaces.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.RangeBorderCollection

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.RangeBorderCollection

Примеры

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const borders = range.format.borders;
    borders.load('items');
    await context.sync();
    
    console.log(borders.count);
    for (let i = 0; i < borders.items.length; i++) {
        console.log(borders.items[i].sideIndex);
    }
});

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths
OfficeExtension.LoadOption

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

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

Excel.RangeBorderCollection

toJSON()

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

toJSON(): Excel.Interfaces.RangeBorderCollectionData;

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

Excel.Interfaces.RangeBorderCollectionData