Excel.ConditionalRangeFormat class
Объект формата, инкапсулирующий шрифт, заливку, границы и другие свойства диапазона условных форматов.
- Extends
Комментарии
Используется
Свойства
| borders | Коллекция объектов границ, которые применяются к общему диапазону условного форматирования. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| fill | Возвращает объект заливки, определенный в общем диапазоне условного форматирования. |
| font | Возвращает объект шрифта, определенный в общем диапазоне условного форматирования. |
| number |
Представляет числовой код формата Excel для заданного диапазона. Дополнительные сведения о числовом форматировании в Excel см. в статье Коды числовых форматов. Очищено, если |
Методы
| clear |
Удаление свойств формата из правила условного форматирования. Создается правило без параметров форматирования. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
borders
Коллекция объектов границ, которые применяются к общему диапазону условного форматирования.
readonly borders: Excel.ConditionalRangeBorderCollection;Значение свойства
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
fill
Возвращает объект заливки, определенный в общем диапазоне условного форматирования.
readonly fill: Excel.ConditionalRangeFill;Значение свойства
Комментарии
font
Возвращает объект шрифта, определенный в общем диапазоне условного форматирования.
readonly font: Excel.ConditionalRangeFont;Значение свойства
Комментарии
numberFormat
Представляет числовой код формата Excel для заданного диапазона. Дополнительные сведения о числовом форматировании в Excel см. в статье Коды числовых форматов. Очищено, если null передается.
numberFormat: any;Значение свойства
any
Комментарии
Сведения о методе
clearFormat()
Удаление свойств формата из правила условного форматирования. Создается правило без параметров форматирования.
clearFormat(): void;Возвращаемое значение
void
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.ConditionalRangeFormatLoadOptions): Excel.ConditionalRangeFormat;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.ConditionalRangeFormat;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ConditionalRangeFormat;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.ConditionalRangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Excel.ConditionalRangeFormat): void;Параметры
- properties
- Excel.ConditionalRangeFormat
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ConditionalRangeFormat объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ConditionalRangeFormatData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.ConditionalRangeFormatData;