• Post category:ApiWorksheet
  • Запись изменена:26.01.2024

new ApiWorksheet()

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

Настройки

Название Описание Описание
Visible логический Возвращает или задает состояние видимости листа.
Active числовой Делает текущий лист активным.
ActiveCell ApiRange Возвращает объект, представляющий активную ячейку.
Selection ApiRange Возвращает объект, представляющий выбранный диапазон.
Cells ApiRange Возвращает ApiRange, который представляет все ячейки на листе (а не только те ячейки, которые используются в данный момент).
Rows ApiRange Возвращает ApiRange, представляющий все ячейки диапазона строк.
Cols ApiRange Возвращает ApiRange, представляющий все ячейки диапазона столбцов.
UsedRange ApiRange Возвращает ApiRange, представляющий используемый диапазон на указанном листе.
Name строковый Возвращает или задает имя активного листа.
Index числовой Возвращает индекс листа.
LeftMargin числовой Возвращает или задает размер левого поля листа, измеряемый в пунктах.
RightMargin числовой Возвращает или задает размер правого поля листа, измеряемый в пунктах.
TopMargin числовой Возвращает или задает размер верхнего поля листа, измеряемый в пунктах.
BottomMargin числовой Возвращает или задает размер нижнего поля листа, измеряемый в пунктах.
PageOrientation PageOrientation Возвращает или задает ориентацию страницы.
PrintHeadings логический Возвращает или задает свойство PrintHeadings страницы.
PrintGridlines логический Возвращает или задает свойство PrintGridlines страницы.
Defnames Array Возвращает массив объектов ApiName.
Comments Array Возвращает массив объектов 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();