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


Excel.RangeFill class

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

Extends

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

color

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

context

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

pattern

Шаблон диапазона. Дополнительные сведения см. в этой Excel.FillPattern статье. LinearGradient и RectangularGradient не поддерживаются. Значение null указывает, что для всего диапазона нет единообразного параметра шаблона.

patternColor

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

patternTintAndShade

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

tintAndShade

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

Методы

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

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

color

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

color: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.1 ]

context

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

context: RequestContext;

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

pattern

Шаблон диапазона. Дополнительные сведения см. в этой Excel.FillPattern статье. LinearGradient и RectangularGradient не поддерживаются. Значение null указывает, что для всего диапазона нет единообразного параметра шаблона.

pattern: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient";

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

Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient"

Комментарии

[ Набор API: ExcelApi 1.9 ]

patternColor

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

patternColor: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

patternTintAndShade

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

patternTintAndShade: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

tintAndShade

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

tintAndShade: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

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

clear()

Сброс фона диапазона.

clear(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFill = range.format.fill;
    rangeFill.clear();
    await context.sync(); 
});

load(options)

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

load(options?: Excel.Interfaces.RangeFillLoadOptions): Excel.RangeFill;

Параметры

options
Excel.Interfaces.RangeFillLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Примеры

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFill = range.format.fill;
    rangeFill.load('color');
    await context.sync();
    console.log(rangeFill.color);
});

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

set(properties, options)

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

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

Параметры

properties
Excel.Interfaces.RangeFillUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.RangeFill): void;

Параметры

properties
Excel.RangeFill

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

void

toJSON()

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

toJSON(): Excel.Interfaces.RangeFillData;

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