new ApiRange()

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

Настройки

НазваниеТипОписание
RowчисловойВозвращает номер строки для выбранной ячейки.
ColчисловойВозвращает номер столбца для выбранной ячейки.
RowsApiRangeВозвращает объект ApiRange, представляющий строки указанного диапазона.
ColsApiRangeВозвращает объект ApiRange, представляющий столбцы указанного диапазона.
CellsApiRangeВозвращает объект Range, который представляет все ячейки в указанном диапазоне или указанной ячейке.
CountчисловойВозвращает количество строк или столбцов.
AddressстроковыйВозвращает адрес диапазона.
ValueстроковыйВозвращает значение из первой ячейки указанного диапазона или устанавливает его в эту ячейку.
FormulaстроковыйВозвращает формулу из первой ячейки указанного диапазона или устанавливает ее в эту ячейку.
Value2строковыйВозвращает значение2 (значение без формата) из первой ячейки указанного диапазона или устанавливает его в эту ячейку.
TextстроковыйВозвращает текст из первой ячейки указанного диапазона или устанавливает его в эту ячейку.
FontColorApiColorУстанавливает цвет текста в текущий диапазон ячеек с помощью ранее созданного цветового объекта.
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логическийВозвращает информацию о стиле переносящей ячейки или указывает, должны ли слова в ячейке переноситься в соответствии с размером ячейки или нет.
FillColorApiColor | ‘No Fill’Возвращает или задает цвет фона текущего диапазона ячеек.
NumberFormatстроковыйУстанавливает значение, представляющее код формата объекта.
MergeAreaApiRangeВозвращает ячейку или диапазон ячеек из области слияния.
WorksheetApiWorksheetВозвращает объект ApiWorksheet, представляющий лист, содержащий указанный диапазон.
DefNameApiNameВозвращает объект ApiName.
CommentsApiComment | nullВозвращает коллекцию ApiComment, которая представляет все комментарии с указанного листа.
Orientation‘xlDownward’ | ‘xlHorizontal’ | ‘xlUpward’ | ‘xlVertical’Устанавливает угол к текущему диапазону ячеек.
AreasApiAreasВозвращает коллекцию областей.
CharactersApiCharactersВозвращает объект 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();

End

  • Запись изменена:10.12.2023
  • Post category:ApiRange

Copy

  • Запись изменена:20.04.2023
  • Post category:ApiRange

Clear

  • Запись изменена:20.04.2023
  • Post category:ApiRange