Excel.RangeBorder class
Представляет границу объекта.
- Extends
Комментарии
Используется
Свойства
| color | Цветовой код HTML, представляющий цвет линии границы, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый"). |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| side |
Постоянное значение, указывающее определенную сторону границы. См. |
| style | Одна из констант стиля линии, определяющая стиль линии границы. См. |
| tint |
Указывает значение double для осветления или затемнения цвета на границе диапазона. Значение от -1 (до 1 (самый темный) и 1 (самый яркий), со значением 0 для исходного цвета. Значение |
| weight | Определяет толщину границы вокруг диапазона. См. |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
color
Цветовой код HTML, представляющий цвет линии границы, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").
color: string;Значение свойства
string
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
sideIndex
Постоянное значение, указывающее определенную сторону границы. См. Excel.BorderIndex дополнительные сведения.
readonly sideIndex: Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp";Значение свойства
Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"
Комментарии
style
Одна из констант стиля линии, определяющая стиль линии границы. См. Excel.BorderLineStyle дополнительные сведения.
style: Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot";Значение свойства
Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot"
Комментарии
Примеры
// Add grid borders around the range.
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:F8";
const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
range.format.borders.getItem('InsideHorizontal').style = 'Continuous';
range.format.borders.getItem('InsideVertical').style = 'Continuous';
range.format.borders.getItem('EdgeBottom').style = 'Continuous';
range.format.borders.getItem('EdgeLeft').style = 'Continuous';
range.format.borders.getItem('EdgeRight').style = 'Continuous';
range.format.borders.getItem('EdgeTop').style = 'Continuous';
await context.sync();
});
tintAndShade
Указывает значение double для осветления или затемнения цвета на границе диапазона. Значение от -1 (до 1 (самый темный) и 1 (самый яркий), со значением 0 для исходного цвета. Значение null указывает, что граница не имеет единого tintAndShade параметра.
tintAndShade: number;Значение свойства
number
Комментарии
weight
Определяет толщину границы вокруг диапазона. См. Excel.BorderWeight дополнительные сведения.
weight: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick";Значение свойства
Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick"
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.RangeBorderLoadOptions): Excel.RangeBorder;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.RangeBorder;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.RangeBorder;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.RangeBorderUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.RangeBorderUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Excel.RangeBorder): void;Параметры
- properties
- Excel.RangeBorder
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.RangeBorder объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.RangeBorderData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.RangeBorderData;