Excel.RangeFormat class

Ссылка

Пакет:: excel

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

Extends: OfficeExtension.ClientObject

Свойства

borders	Коллекция объектов границ, которые применяются ко всему диапазону.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
fill	Возвращает объект заливки, определенный для всего диапазона.
font	Возвращает объект шрифта, определенный для всего диапазона.
horizontalAlignment	Представляет выравнивание по горизонтали для указанного объекта. Дополнительные сведения см. в этой `Excel.HorizontalAlignment` статье.
verticalAlignment	Представляет выравнивание по вертикали для указанного объекта. Дополнительные сведения см. в этой `Excel.VerticalAlignment` статье.
wrapText	Указывает, будет ли 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.RangeFormat является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.RangeFormatData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

borders

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

readonly borders: Excel.RangeBorderCollection;

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

Excel.RangeBorderCollection

context

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

context: RequestContext;

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

Excel.RequestContext

fill

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

readonly fill: Excel.RangeFill;

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

Excel.RangeFill

font

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

readonly font: Excel.RangeFont;

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

Excel.RangeFont

horizontalAlignment

Представляет выравнивание по горизонтали для указанного объекта. Дополнительные сведения см. в этой Excel.HorizontalAlignment статье.

horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";

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

verticalAlignment

Представляет выравнивание по вертикали для указанного объекта. Дополнительные сведения см. в этой Excel.VerticalAlignment статье.

verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";

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

wrapText

Указывает, будет ли Excel переносить текст в объект . null Значение указывает, что для всего диапазона не задано равномерное обертывание.

wrapText: boolean;

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

boolean

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

load(options)

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

load(options?: Excel.Interfaces.RangeFormatLoadOptions): Excel.RangeFormat;

Параметры

options: Excel.Interfaces.RangeFormatLoadOptions

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

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

Excel.RangeFormat

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.RangeFormat

Примеры

// Select all of the range's format properties.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    range.load(["format/*", "format/fill", "format/borders", "format/font"]);
    await context.sync();
    
    console.log(range.format.wrapText);
    console.log(range.format.fill.color);
    console.log(range.format.font.name);
});

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Excel.RangeFormat

set(properties, options)

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

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

Параметры

properties: Excel.Interfaces.RangeFormatUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.RangeFormat): void;

Параметры

properties: Excel.RangeFormat

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

void

toJSON()

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

toJSON(): Excel.Interfaces.RangeFormatData;

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

Excel.Interfaces.RangeFormatData

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

Excel.RangeFormat class

Комментарии

Свойства

Методы

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

borders

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

Комментарии

context

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

fill

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

Комментарии

font

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

Комментарии

horizontalAlignment

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

Комментарии

verticalAlignment

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

Комментарии

wrapText

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

Комментарии

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

load(options)

Параметры

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

load(propertyNames)

Параметры

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

Примеры

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

Обратная связь

Дополнительные ресурсы