Excel.RangeFormat interface

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

Свойства

autoIndent

Указывает, отображается ли отступ текста автоматически, если для выравнивания текста задано равномерное распределение.

borders

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

columnWidth

Задает ширину всех колумс в диапазоне. Если столбцы разной ширины, будет возвращено значение NULL.

fill

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

font

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

horizontalAlignment

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

indentLevel

Целое число от 0 до 250, указывающее уровень отступа.

protection

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

readingOrder

Направление чтения для диапазона.

rowHeight

Высота всех строк в диапазоне. Если высота строк не одинакова, возвращается значение null.

shrinkToFit

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

textOrientation

Ориентация текста для всех ячеек в диапазоне. Ориентация текста должна быть целым числом от – 90 до 90 или 180 для вертикально ориентированного текста. Если ориентация в диапазоне не одинакова, возвращается значение null.

useStandardHeight

Определяет, равна ли высота строки объекта Range стандартной высоте листа. Возвращает значение true, если высота строки объекта Range равна стандартной высоте листа. Возвращает значение null, если диапазон содержит более одной строки, а строки имеют одинаковую высоту. Возвращает false в противном случае.

useStandardWidth

Указывает, совпадает ли ширина столбца объекта Range со стандартной шириной листа. Возвращает значение true, если ширина столбца объекта Range равна стандартной ширине листа. Возвращает значение null, если диапазон содержит более одного столбца, а столбцы имеют одинаковую высоту. Возвращает false в противном случае.

verticalAlignment

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

wrapText

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

Методы

adjustIndent(amount)

Настраивает отступ для форматирования диапазона. Значение отступа лежит в диапазоне от 0 до 250 и измеряется в символах.

autofitColumns()

Изменяет ширину столбцов текущего диапазона на оптимальную с учетом текущих данных в столбцах.

autofitRows()

Изменяет высоту строк текущего диапазона на оптимальную с учетом текущих данных в столбцах.

load(propertyNames)

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

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

autoIndent

Указывает, отображается ли отступ текста автоматически, если для выравнивания текста задано равномерное распределение.

autoIndent: boolean;

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

boolean

borders

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

readonly borders: RangeBorderCollection;

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

columnWidth

Задает ширину всех колумс в диапазоне. Если столбцы разной ширины, будет возвращено значение NULL.

columnWidth: number;

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

number

fill

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

readonly fill: RangeFill;

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

font

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

readonly font: RangeFont;

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

horizontalAlignment

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

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

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

| HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"

indentLevel

Целое число от 0 до 250, указывающее уровень отступа.

indentLevel: number;

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

number

protection

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

readonly protection: FormatProtection;

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

readingOrder

Направление чтения для диапазона.

readingOrder: ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";

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

ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"

rowHeight

Высота всех строк в диапазоне. Если высота строк не одинакова, возвращается значение null.

rowHeight: number;

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

number

shrinkToFit

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

shrinkToFit: boolean;

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

boolean

textOrientation

Ориентация текста для всех ячеек в диапазоне. Ориентация текста должна быть целым числом от – 90 до 90 или 180 для вертикально ориентированного текста. Если ориентация в диапазоне не одинакова, возвращается значение null.

textOrientation: number;

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

number

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let range = sheet.getRange("B2:E2");

    // Set textOrientation to either an integer between -90 and 90
    // or to 180 for vertically-oriented text.
    range.format.textOrientation = 90;

    await context.sync();
}

useStandardHeight

Определяет, равна ли высота строки объекта Range стандартной высоте листа. Возвращает значение true, если высота строки объекта Range равна стандартной высоте листа. Возвращает значение null, если диапазон содержит более одной строки, а строки имеют одинаковую высоту. Возвращает false в противном случае.

useStandardHeight: boolean;

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

boolean

useStandardWidth

Указывает, совпадает ли ширина столбца объекта Range со стандартной шириной листа. Возвращает значение true, если ширина столбца объекта Range равна стандартной ширине листа. Возвращает значение null, если диапазон содержит более одного столбца, а столбцы имеют одинаковую высоту. Возвращает false в противном случае.

useStandardWidth: boolean;

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

boolean

verticalAlignment

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

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

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

| VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"

wrapText

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

wrapText: boolean;

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

boolean

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

adjustIndent(amount)

Настраивает отступ для форматирования диапазона. Значение отступа лежит в диапазоне от 0 до 250 и измеряется в символах.

adjustIndent(amount: number): void;

Параметры

amount
number

Количество символьных пространств, на которое регулируется текущий отступ. Это значение должно находиться в пределах от – 250 до 250. Note: если сумма приведет к увеличению уровня отступа выше 250, уровень отступа остается в 250. Аналогично, если значение меньше уровня отступа ниже 0, уровень отступа остается равным 0.

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

void

autofitColumns()

Изменяет ширину столбцов текущего диапазона на оптимальную с учетом текущих данных в столбцах.

autofitColumns(): void;

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

void

autofitRows()

Изменяет высоту строк текущего диапазона на оптимальную с учетом текущих данных в столбцах.

autofitRows(): void;

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

void

load(propertyNames)

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

load(propertyNames?: string | string[]): void;

Параметры

propertyNames
string | string[]

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

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

void