new ApiWorksheet()

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

Настройки

НазваниеОписаниеОписание
VisibleлогическийВозвращает или задает состояние видимости листа.
ActiveчисловойДелает текущий лист активным.
ActiveCellApiRangeВозвращает объект, представляющий активную ячейку.
SelectionApiRangeВозвращает объект, представляющий выбранный диапазон.
CellsApiRangeВозвращает ApiRange, который представляет все ячейки на листе (а не только те ячейки, которые используются в данный момент).
RowsApiRangeВозвращает ApiRange, представляющий все ячейки диапазона строк.
ColsApiRangeВозвращает ApiRange, представляющий все ячейки диапазона столбцов.
UsedRangeApiRangeВозвращает ApiRange, представляющий используемый диапазон на указанном листе.
NameстроковыйВозвращает или задает имя активного листа.
IndexчисловойВозвращает индекс листа.
LeftMarginчисловойВозвращает или задает размер левого поля листа, измеряемый в пунктах.
RightMarginчисловойВозвращает или задает размер правого поля листа, измеряемый в пунктах.
TopMarginчисловойВозвращает или задает размер верхнего поля листа, измеряемый в пунктах.
BottomMarginчисловойВозвращает или задает размер нижнего поля листа, измеряемый в пунктах.
PageOrientationPageOrientationВозвращает или задает ориентацию страницы.
PrintHeadingsлогическийВозвращает или задает свойство PrintHeadings страницы.
PrintGridlinesлогическийВозвращает или задает свойство PrintGridlines страницы.
DefnamesArrayВозвращает массив объектов ApiName.
CommentsArrayВозвращает массив объектов ApiComment.

Методы

НазваниеОписание
AddChartСоздает диаграмму указанного типа из выбранного диапазона данных текущего листа.
Обратите внимание, что горизонтальное и вертикальное смещения рассчитываются только в пределах указанных ячеек столбца и строки. Если это значение превышает ширину или высоту ячейки, будет установлено другое вертикальное/горизонтальное положение.
AddDefNameДобавляет новое имя к текущему листу.
AddImageДобавляет изображение на текущий лист с указанными параметрами.
AddOleObjectДобавляет объект OLE на текущий лист с указанными параметрами.
AddShapeДобавляет фигуру на текущий лист с указанными параметрами.
Обратите внимание, что горизонтальное и вертикальное смещения рассчитываются только в пределах указанных ячеек столбца и строки. Если это значение превышает ширину или высоту ячейки, будет установлено другое вертикальное/горизонтальное положение.
AddWordArtДобавляет объект Text Art на текущий лист с указанными параметрами.
DeleteУдаляет текущий лист.
FormatAsTableФорматирует выбранный диапазон ячеек текущего листа как таблицу (первая строка отформатирована как заголовок).
Поскольку первая строка всегда форматируется как заголовок таблицы, вам необходимо выбрать как минимум две строки, чтобы таблица сформировалась правильно.
GetActiveCellВозвращает объект, представляющий активную ячейку.
GetAllChartsВозвращает все диаграммы с текущего листа.
GetAllDrawingsВозвращает все рисунки с текущего листа.
GetAllImagesВозвращает все изображения с текущего листа.
GetAllOleObjectsВозвращает все объекты OLE с текущего листа.
GetAllShapesВозвращает все фигуры с текущего листа.
GetBottomMarginВозвращает нижнее поле листа.
GetCellsВозвращает ApiRange, который представляет все ячейки на листе (а не только те ячейки, которые используются в данный момент).
GetColsВозвращает объект ApiRange, представляющий все ячейки диапазона столбцов.
GetCommentsВозвращает массив объектов ApiComment.
GetDefNameВозвращает объект ApiName по имени листа.
GetDefNamesВозвращает массив объектов ApiName.
GetIndexВозвращает индекс листа.
GetLeftMarginВозвращает левое поле листа.
GetNameВозвращает имя листа.
GetPageOrientationВозвращает ориентацию страницы.
GetPrintGridlinesВозвращает свойство страницы PrintGridlines, которое указывает, должны ли печатать линии сетки текущего листа или нет.
GetPrintHeadingsВозвращает свойство страницы PrintHeadings, которое указывает, должны ли быть напечатаны заголовки строк/столбцов текущего листа.
GetRangeВозвращает объект, представляющий выбранный диапазон текущего листа. Это может быть одна ячейка — А1, или ячейки из одной строки — А1:Е1, или ячейки из одного столбца — А1:А10, или ячейки из нескольких строк и столбцов — А1:Е10.
GetRangeByNumberВозвращает объект, который представляет выбранный диапазон текущего листа, используя координаты строки/столбца для выбора ячейки.
GetRightMarginВозвращает правое поле листа.
GetRowsВозвращает объект ApiRange, представляющий все ячейки диапазона строк.
GetSelectionВозвращает объект, представляющий выбранный диапазон.
GetTopMarginВозвращает верхнее поле листа.
GetUsedRangeВозвращает объект ApiRange, представляющий используемый диапазон на указанном листе.
GetVisibleВозвращает состояние видимости листа.
MoveПеремещает текущий лист в другое место книги.
ReplaceCurrentImageЗаменяет текущее изображение новым.
SetActiveДелает текущий лист активным.
SetBottomMarginУстанавливает нижнее поле листа.
SetColumnWidthУстанавливает ширину указанного столбца. Одна единица ширины столбца равна ширине одного символа в обычном стиле. Для пропорциональных шрифтов используется ширина символа 0 (ноль).
SetDisplayGridlinesУказывает, должны ли отображаться линии сетки текущего листа или нет.
SetDisplayHeadingsУказывает, должны ли отображаться заголовки строк/столбцов текущего листа.
SetHyperlinkДобавляет гиперссылку в указанный диапазон.
SetLeftMarginУстанавливает левое поле листа.
SetNameЗадает имя текущему активному листу.
SetPageOrientationУстанавливает ориентацию страницы.
SetPrintGridlinesУказывает, нужно ли печатать текущие линии сетки листа.
SetPrintHeadingsУказывает, нужно ли печатать заголовки строк/столбцов текущего листа.
SetRightMarginУстанавливает правое поле листа.
SetRowHeightУстанавливает высоту указанной строки, измеряемую в пунктах. Пункт равен 1/72 дюйма.
SetTopMarginУстанавливает верхнее поле листа.
SetVisibleУстанавливает состояние видимости листа.

Пример

builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
oWorksheet.SetName("sheet 1");
oWorksheet.GetRange("B1").SetValue("Row 1");
oWorksheet.GetRange("C1").SetValue("Row 2");
oWorksheet.GetRange("D1").SetValue("Row 3");
oWorksheet.GetRange("A2").SetValue("Category 1");
oWorksheet.GetRange("A3").SetValue("Category 2");
oWorksheet.GetRange("A4").SetValue("Category 3");
oWorksheet.GetRange("A5").SetValue("Category 4");
oWorksheet.GetRange("B2").SetValue("4.3");
oWorksheet.GetRange("B3").SetValue("2.5");
oWorksheet.GetRange("B4").SetValue("3.5");
oWorksheet.GetRange("B5").SetValue("4.5");
oWorksheet.GetRange("C2").SetValue("2.4");
oWorksheet.GetRange("C3").SetValue("4.4");
oWorksheet.GetRange("C4").SetValue("1.8");
oWorksheet.GetRange("C5").SetValue("2.8");
oWorksheet.GetRange("D2").SetValue("2");
oWorksheet.GetRange("D3").SetValue("2");
oWorksheet.GetRange("D4").SetValue("3");
oWorksheet.GetRange("D5").SetValue("5");
var oChart = oWorksheet.AddChart("'sheet 1'!$A$1:$D$5", true, "bar", 2, 100 * 36000, 70 * 36000, 0, 2 * 36000, 9, 3 * 36000);
oChart.SetVerAxisTitle("Vertical Title", 10);
oChart.SetHorAxisTitle("Horizontal Title", 11);
oChart.SetLegendPos("right");
oChart.SetShowDataLabels(false, false, true, false);
oChart.SetTitle("Main Chart Title", 13);
var oFill = Api.CreateSolidFill(Api.CreateRGBColor(51, 51, 51));
oChart.SetSeriesFill(oFill, 0, false);
oFill = Api.CreateSolidFill(Api.CreateRGBColor(255, 111, 61));
oChart.SetSeriesFill(oFill, 1, false);
oFill = Api.CreateSolidFill(Api.CreateRGBColor(128, 128, 128));
oChart.SetSeriesFill(oFill, 2, false);
oFill = Api.CreateSolidFill(Api.CreateRGBColor(255, 213, 191));
oChart.SetSeriesFill(oFill, 3, false);
oWorksheet.AddDefName("chart data", "Sheet1!$A$1:$D$5");
oWorksheet.GetRange("A8").SetValue("We defined a name 'chart data' for a range of cells A1:D5.");
oWorksheet.AddImage("https://TEST_URL/docbuilder/examples/coordinate_aspects.png", 60 * 36000, 35 * 36000, 5, 2 * 36000, 0, 3 * 36000);
var oGs1 = Api.CreateGradientStop(Api.CreateRGBColor(255, 213, 191), 0);
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 111, 61), 100000);
oFill = Api.CreateLinearGradientFill([oGs1, oGs2], 5400000);
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
oWorksheet.AddShape("flowChartOnlineStorage", 60 * 36000, 35 * 36000, oFill, oStroke, 0, 2 * 36000, 25, 3 * 36000);
oWorksheet.FormatAsTable("A1:D5");
builder.SaveFile("xlsx", "ApiWorksheet.xlsx");
builder.CloseFile();