Excel.ConditionalRangeFill class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: ExcelApi 1.6

Используется

• Excel.ConditionalRangeFormat: заполнение

Свойства

color	Цветовой код HTML, представляющий цвет заливки в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

Методы

clear()	Удаляет заливку.
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.ConditionalRangeFill объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ConditionalRangeFillData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

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

color

Цветовой код HTML, представляющий цвет заливки в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").

color: string;

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

string

Комментарии

Набор API: ExcelApi 1.6

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B21:E23");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.topBottom);
    conditionalFormat.topBottom.format.fill.color = "green"
    conditionalFormat.topBottom.rule = { 
        rank: 1, 
        type: Excel.ConditionalTopBottomCriterionType.topItems
    };

    await context.sync();
});

context

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

context: RequestContext;

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

Excel.RequestContext

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

clear()

Удаляет заливку.

clear(): void;

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

void

Комментарии

Набор API: ExcelApi 1.6

load(options)

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

load(options?: Excel.Interfaces.ConditionalRangeFillLoadOptions): Excel.ConditionalRangeFill;

Параметры

options

Excel.Interfaces.ConditionalRangeFillLoadOptions

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

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

Excel.ConditionalRangeFill

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.ConditionalRangeFill

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.ConditionalRangeFill

set(properties, options)

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

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

Параметры

properties

Excel.Interfaces.ConditionalRangeFillUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Excel.ConditionalRangeFill): void;

Параметры

properties

Excel.ConditionalRangeFill

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

void

toJSON()

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

toJSON(): Excel.Interfaces.ConditionalRangeFillData;

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

Excel.Interfaces.ConditionalRangeFillData