Excel.ConditionalRangeFormat class

Пакет:

excel

Объект формата, инкапсулирующий шрифт, заливку, границы и другие свойства диапазона условных форматов.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.6 ]

Свойства

borders	Коллекция объектов границы, которые применяются к общему диапазону условного формата.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
fill	Возвращает объект заполнения, определенный в общем диапазоне условного формата.
font	Возвращает объект шрифта, определенный в общем диапазоне условного формата.
numberFormat	Представляет код числового формата Excel для заданного диапазона. Дополнительные сведения о форматировании чисел в Excel см. в разделе Коды числового формата. Очищается, если null передается.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.ConditionalRangeFormat является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ConditionalRangeFormatData), содержащий неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

borders

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

readonly borders: Excel.ConditionalRangeBorderCollection;

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

Excel.ConditionalRangeBorderCollection

Комментарии

[ Набор API: ExcelApi 1.6 ]

context

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

context: RequestContext;

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

Excel.RequestContext

fill

Возвращает объект заполнения, определенный в общем диапазоне условного формата.

readonly fill: Excel.ConditionalRangeFill;

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

Excel.ConditionalRangeFill

Комментарии

[ Набор API: ExcelApi 1.6 ]

font

Возвращает объект шрифта, определенный в общем диапазоне условного формата.

readonly font: Excel.ConditionalRangeFont;

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

Excel.ConditionalRangeFont

Комментарии

[ Набор API: ExcelApi 1.6 ]

numberFormat

Представляет код числового формата Excel для заданного диапазона. Дополнительные сведения о форматировании чисел в Excel см. в разделе Коды числового формата. Очищается, если null передается.

numberFormat: any;

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

any

Комментарии

[ Набор API: ExcelApi 1.6 ]

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

load(options)

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

load(options?: Excel.Interfaces.ConditionalRangeFormatLoadOptions): Excel.ConditionalRangeFormat;

Параметры

options

Excel.Interfaces.ConditionalRangeFormatLoadOptions

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

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

Excel.ConditionalRangeFormat

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.ConditionalRangeFormat

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ConditionalRangeFormat;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

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

Excel.ConditionalRangeFormat

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.ConditionalRangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties

Excel.Interfaces.ConditionalRangeFormatUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options

OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

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

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;

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

Excel.Interfaces.ConditionalRangeFormatData