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


Excel.RangeFormat class

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

Extends

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

autoIndent

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

borders

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

columnWidth

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

context

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

fill

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

font

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

horizontalAlignment

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

indentLevel

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

protection

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

readingOrder

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

rowHeight

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

shrinkToFit

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

textOrientation

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

useStandardHeight

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

useStandardWidth

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

verticalAlignment

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

wrapText

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

Методы

adjustIndent(amount)

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

autofitColumns()

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

autofitRows()

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

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), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

autoIndent

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

autoIndent: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

borders

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

readonly borders: Excel.RangeBorderCollection;

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

columnWidth

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

columnWidth: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.2 ]

context

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

context: RequestContext;

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

fill

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

readonly fill: Excel.RangeFill;

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

font

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

readonly font: Excel.RangeFont;

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

horizontalAlignment

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

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

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

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

indentLevel

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

indentLevel: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

protection

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

readonly protection: Excel.FormatProtection;

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

Комментарии

[ Набор API: ExcelApi 1.2 ]

readingOrder

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

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

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

Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"

Комментарии

[ Набор API: ExcelApi 1.9 ]

rowHeight

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

rowHeight: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.2 ]

shrinkToFit

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

shrinkToFit: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

textOrientation

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

textOrientation: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.7 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-text-orientation.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const 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 . Примечание. Это свойство предназначено только для присвоения значения true. Установка значения не false оказывает никакого влияния.

useStandardHeight: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

useStandardWidth

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

useStandardWidth: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

verticalAlignment

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

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

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

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

wrapText

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

wrapText: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

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

adjustIndent(amount)

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

adjustIndent(amount: number): void;

Параметры

amount

number

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

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

void

Комментарии

[ Набор API: ExcelApi 1.11 ]

autofitColumns()

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

autofitColumns(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

autofitRows()

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

autofitRows(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

load(options)

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

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

Параметры

options
Excel.Interfaces.RangeFormatLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Примеры

// 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)

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

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

Параметры

propertyNamesAndPaths

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

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

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

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;

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