Продукты Р7
Корпоративный сервер 2024
Корпоративный сервер 2024
Сервер документов
Сервер документов
Редакторы
Редакторы
Корпоративный сервер 2019
Корпоративный сервер 2019
Графика
Графика
Команда
Команда
Мобильные редакторы
Мобильные редакторы
Облачный офис
Облачный офис
Почта
Почта
Органайзер
Органайзер
Дополнительно
Часто задаваемые вопросы
Разработчикам
Интеграции
Новые возможности

Справочник методов класса ApiRange таблиц

Обновлено: 15.12.25

new ApiRange()

Класс, представляющий диапазон.

Настройки

Название Тип Описание
Row числовой Возвращает номер строки для выбранной ячейки.
Col числовой Возвращает номер столбца для выбранной ячейки.
Rows ApiRange Возвращает объект ApiRange, представляющий строки указанного диапазона.
Cols ApiRange Возвращает объект ApiRange, представляющий столбцы указанного диапазона.
Cells ApiRange Возвращает объект Range, который представляет все ячейки в указанном диапазоне или указанной ячейке.
Count числовой Возвращает количество строк или столбцов.
Address строковый Возвращает адрес диапазона.
Value строковый Возвращает значение из первой ячейки указанного диапазона или устанавливает его в эту ячейку.
Formula строковый Возвращает формулу из первой ячейки указанного диапазона или устанавливает ее в эту ячейку.
Value2 строковый Возвращает значение2 (значение без формата) из первой ячейки указанного диапазона или устанавливает его в эту ячейку.
Text строковый Возвращает текст из первой ячейки указанного диапазона или устанавливает его в эту ячейку.
FontColor ApiColor Устанавливает цвет текста в текущий диапазон ячеек с помощью ранее созданного цветового объекта.
Hidden логический Возвращает или задает свойство скрытия значения.
ColumnWidth числовой Возвращает или задает ширину всех столбцов в указанном диапазоне, измеренную в пунктах.
Width числовой Возвращает значение, представляющее ширину диапазона, измеренную в пунктах.
RowHeight числовой Возвращает или задает высоту первой строки в указанном диапазоне, измеряемую в пунктах.
Height числовой Возвращает значение, представляющее высоту диапазона, измеренную в пунктах.
FontSize числовой Устанавливает размер шрифта в соответствии с символами текущего диапазона ячеек.
FontName строковый Устанавливает указанное семейство шрифтов в качестве имени шрифта для текущего диапазона ячеек.
AlignVertical ‘center’ | ‘bottom’ | ‘top’ | ‘distributed’ | ‘justify’ Устанавливает вертикальное выравнивание текста по текущему диапазону ячеек.
AlignHorizontal ‘left’ | ‘right’ | ‘center’ | ‘justify’ Устанавливает горизонтальное выравнивание текста по текущему диапазону ячеек.
Bold логический Устанавливает свойство полужирного шрифта для текстовых символов из текущей ячейки или диапазона ячеек.
Italic логический Устанавливает свойство курсива для текстовых символов в текущей ячейке или диапазоне ячеек.
Underline ‘none’ | ‘single’ | ‘singleAccounting’ | ‘double’ | ‘doubleAccounting’ Устанавливает тип подчеркивания, применяемого к шрифту.
Strikeout логический Устанавливает значение, указывающее, отображается ли содержимое текущей ячейки или диапазона ячеек зачеркнутым.
WrapText логический Возвращает информацию о стиле переносящей ячейки или указывает, должны ли слова в ячейке переноситься в соответствии с размером ячейки или нет.
FillColor ApiColor | ‘No Fill’ Возвращает или задает цвет фона текущего диапазона ячеек.
NumberFormat строковый Устанавливает значение, представляющее код формата объекта.
MergeArea ApiRange Возвращает ячейку или диапазон ячеек из области слияния.
Worksheet ApiWorksheet Возвращает объект ApiWorksheet, представляющий лист, содержащий указанный диапазон.
DefName ApiName Возвращает объект ApiName.
Comments ApiComment | null Возвращает коллекцию ApiComment, которая представляет все комментарии с указанного листа.
Orientation ‘xlDownward’ | ‘xlHorizontal’ | ‘xlUpward’ | ‘xlVertical’ Устанавливает угол к текущему диапазону ячеек.
Areas ApiAreas Возвращает коллекцию областей.
Characters ApiCharacters Возвращает объект ApiCharacters, представляющий диапазон символов в тексте объекта. Используйте объект ApiCharacters для форматирования символов в текстовой строке.

Методы

Название Описание
AddComment ↗ Добавляет комментарий к текущему диапазону.
AutoFit ↗ Изменяет ширину столбцов или высоту строк в диапазоне для достижения наилучшего соответствия.
Clear ↗ Очищает текущий диапазон.
Copy ↗ Копирует диапазон в указанный диапазон.
Delete ↗ Удаляет объект Range.
End ↗ Возвращает объект Range, который представляет конец в указанном направлении в указанном диапазоне.
Find ↗ Находит конкретную информацию в текущем диапазоне.
FindNext ↗ Продолжает поиск, начатый с помощью метода ApiRange#Find. Находит следующую ячейку, соответствующую тем же условиям, и возвращает объект ApiRange, представляющий эту ячейку. Это не влияет на выделение или активную ячейку.
FindPrevious ↗ Продолжает поиск, начатый с помощью метода ApiRange#Find. Находит предыдущую ячейку, соответствующую тем же условиям, и возвращает объект ApiRange, представляющий эту ячейку. Это не влияет на выделение или активную ячейку.
ForEach ↗ Выполняет предоставленную функцию один раз для каждой ячейки.
GetAddress ↗ Возвращает адрес диапазона.
GetAreas ↗ Возвращает коллекцию диапазонов.
GetCells ↗ Возвращает объект Range, который представляет все ячейки в указанном диапазоне или указанной ячейке.
GetCharacters ↗ Возвращает объект ApiCharacters, представляющий диапазон символов в тексте объекта. Используйте объект ApiCharacters для форматирования символов в текстовой строке.
GetClassType ↗ Возвращает тип класса ApiRange.
GetCol ↗ Возвращает номер столбца для выбранной ячейки.
GetCols ↗ Возвращает объект Range, представляющий столбцы в указанном диапазоне.
GetColumnWidth ↗ Возвращает значение ширины столбца.
GetComment ↗ Возвращает объект ApiComment текущего диапазона.
GetCount ↗ Возвращает количество строк или столбцов.
GetDefName ↗ Возвращает объект ApiName текущего диапазона.
GetFillColor ↗ Возвращает цвет фона для текущего диапазона ячеек. Возвращает значение «Нет заливки», если цвет фона в ячейке/диапазоне ячеек равен нулю.
GetFormula ↗ Возвращает формулу указанного диапазона.
GetHidden ↗ Возвращает свойство скрытия значения. Указанный диапазон должен охватывать весь столбец или строку.
GetNumberFormat ↗ Возвращает значение, представляющее код формата для текущего диапазона.
GetOrientation ↗ Возвращает текущий угол диапазона.
GetRow ↗ Возвращает номер строки для выбранной ячейки.
GetRowHeight ↗ Возвращает значение высоты строки.
GetRows ↗ Возвращает объект Range, представляющий строки в указанном диапазоне. Если указанная строка находится за пределами объекта Range, будет возвращен новый диапазон, представляющий ячейки между столбцами исходного диапазона в указанной строке.
GetText ↗ Возвращает текст указанного диапазона.
GetValue ↗ Возвращает значение указанного диапазона.
GetValue2 ↗ Возвращает свойство Value2 (значение без формата) указанного диапазона.
GetWorksheet ↗ Возвращает объект Worksheet, представляющий лист, содержащий указанный диапазон. Он будет доступен в режиме только для чтения.
GetWrapText ↗ Возвращает информацию о стиле переносящей ячейки.
Insert ↗ Вставляет ячейку или диапазон ячеек в лист или лист макроса и сдвигает другие ячейки, чтобы освободить место.
Merge ↗ Объединяет выбранный диапазон ячеек в одну ячейку или строку ячеек.
Paste ↗ Вставляет объект Range в указанный диапазон.
Replace ↗ Заменяет определенную информацию на другую в диапазоне.
Select ↗ Выбор текущего диапазона.
SetAlignHorizontal ↗ Устанавливает горизонтальное выравнивание текста в текущем диапазоне ячеек.
SetAlignVertical ↗ Устанавливает вертикальное выравнивание текста в текущем диапазоне ячеек.
SetBold ↗ Устанавливает свойство полужирного текста для текстовых символов в текущей ячейке или диапазоне ячеек.
SetBorders ↗ Устанавливает границу ячейки/диапазона ячеек с указанными параметрами.
SetColumnWidth ↗ Устанавливает ширину всех столбцов в текущем диапазоне. Одна единица ширины столбца равна ширине одного символа в обычном стиле. Для пропорциональных шрифтов используется ширина символа 0 (ноль).
SetFillColor ↗ Устанавливает цвет фона для текущего диапазона ячеек с помощью ранее созданного цветового объекта. Устанавливает «Нет заливки», когда ранее созданный цветовой объект имеет значение NULL.
SetFontColor ↗ Устанавливает цвет текста в текущий диапазон ячеек с помощью ранее созданного цветового объекта.
SetFontName ↗ Устанавливает указанное семейство шрифтов в качестве имени шрифта для текущего диапазона ячеек.
SetFontSize ↗ Устанавливает размер шрифта в соответствии с символами текущего диапазона ячеек.
SetHidden ↗ Устанавливает свойство скрытия значения. Указанный диапазон должен охватывать весь столбец или строку.
SetItalic ↗ Устанавливает свойство курсива для текстовых символов в текущей ячейке или диапазоне ячеек.
SetNumberFormat ↗ Указывает, следует ли интерпретировать число в ячейке как число, валюту, дату, время и т. д. или просто как текст.
SetOffset ↗ Устанавливает смещение ячейки.
SetOrientation ↗ Устанавливает угол к текущему диапазону ячеек.
SetRowHeight ↗ Устанавливает значение высоты строки.
SetSort ↗ Сортирует ячейки заданного диапазона по параметрам, указанным в запросе.
SetStrikeout ↗ Указывает, что содержимое ячейки/диапазона ячеек отображается одной горизонтальной линией, проходящей через центр содержимого.
SetUnderline ↗ Указывает, что содержимое текущей ячейки/диапазона ячеек отображается вместе со строкой, появляющейся непосредственно под символом.
SetValue ↗ Устанавливает значение для текущей ячейки или диапазона ячеек.
SetWrap ↗ Указывает, должны ли слова в ячейке переноситься в соответствии с размером ячейки или нет.
UnMerge ↗ Разбивает выбранный объединенный диапазон ячеек на отдельные ячейки.

Пример

builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oRange = oWorksheet.GetRange("A1");
oRange.SetValue(2);
oRange.AddComment("This is just a number.");
oWorksheet.GetRange("B1").SetValue(2);
oWorksheet.GetRange("C1").SetValue("1");
oWorksheet.GetRange("A3").SetValue("2+2=");
oWorksheet.GetRange("B3").SetValue("=SUM(A1:B1)");
oRange = oWorksheet.GetRange("A1:B1");
oRange.ForEach(function (range) {
var sValue = range.GetValue();
if (sValue != "1") {
range.SetBold(true);
}
});
var sAddress = oWorksheet.GetRange("A1").GetAddress(true, true, "xlA1", false);
oWorksheet.GetRange("A2").SetValue("Address: " + sAddress);
var sClassType = oRange.GetClassType();
oWorksheet.GetRange('A7').SetValue("Class type: " + sClassType);
oRange = oWorksheet.GetRange("A4:B4");
oRange.SetValue("1");
oRange.Clear();
oWorksheet.GetRange("A5").SetValue("The range A4:B4 was just cleared.");
oRange = oWorksheet.GetRange("C6:D7");
oRange.End("xlToLeft").SetFillColor(Api.CreateColorFromRGB(255, 213, 191));
oRange.GetCells(2, 1).SetFillColor(Api.CreateColorFromRGB(255, 213, 191));
oRange = oWorksheet.GetRange("D9").GetCol();
oWorksheet.GetRange("C7").SetValue(oRange.toString());
oRange = oWorksheet.GetRange("A1:C3");
oRange.GetCols(3).SetFillColor(Api.CreateColorFromRGB(255, 213, 191));
var nWidth = oWorksheet.GetRange("A1").GetColumnWidth();
oWorksheet.GetRange("A8").SetValue("Width: " + nWidth);
oWorksheet.GetRange("A9").SetValue("Comment: " + oWorksheet.GetRange("A1").GetComment().GetText());
var nCount = oWorksheet.GetRange("A9:C9").GetCount();
oWorksheet.GetRange("A10").SetValue("Count: " + nCount);
Api.AddDefName("numbers", "Sheet1!$A$1:$B$1");
var oDefName = oWorksheet.GetRange("A1:B1").GetDefName("numbers");
oWorksheet.GetRange("A11").SetValue("DefName of the A1:B1 range: " + oDefName.GetName());
oRange = oWorksheet.GetRange("E1");
oRange.SetFillColor(Api.CreateColorFromRGB(255, 213, 191));
oRange.SetValue("This is the cell with a color set to its background.");
var oFillColor = oRange.GetFillColor();
oWorksheet.GetRange("E3").SetValue("This is another cell with the same color set to its background");
oWorksheet.GetRange("E3").SetFillColor(oFillColor);
oWorksheet.GetRange("13:14").SetHidden(true);
var bHidden = oWorksheet.GetRange("13:14").GetHidden();
oWorksheet.GetRange("A15").SetValue("The A13:A14 range is hidden: " + bHidden);
builder.SaveFile("xlsx", "ApiRange.xlsx");
builder.CloseFile();