METHOD Delete
Удаляет объект ApiCharacters.
API таблиц
Начало работы с электронной таблицей API
API Классы
CLASS ApiCharacters
new ApiCharacters()
Класс, представляющий символы в объекте, содержащем текст.
Характеристики
| Название | Тип | Описание |
| Count | числовой | Количество персонажей в коллекции. |
| Parent | ApiRange | Родительский объект указанных символов. |
| Caption | строковый | Текст указанного диапазона символов. |
| Text | строковый | Строковое значение, представляющее текст указанного диапазона символов. |
| Font | ApiFont | Шрифт указанных символов. |
Методы
METHOD GetCaption
Возвращает строковое значение, представляющее текст указанного диапазона символов.
METHOD GetCount
Возвращает значение, представляющее количество объектов в коллекции.
METHOD GetFont
Возвращает объект ApiFont, представляющий шрифт указанных символов.
METHOD GetParent
Возвращает родительский объект указанных символов.
METHOD GetText
Возвращает текст указанного диапазона символов.
METHOD Insert
Вставляет строку, заменяющую указанные символы.
METHOD SetCaption
Устанавливает строковое значение, представляющее текст указанного диапазона символов.
METHOD SetText
Устанавливает текст для указанных символов.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oRange = oWorksheet.GetRange("B1");
oRange.SetValue("This is just a sample text.");
var oCharacters = oRange.GetCharacters(16, 6);
var oFont = oCharacters.GetFont();
oFont.SetBold(true);
var sCaption = oCharacters.GetCaption();
oWorksheet.GetRange("B3").SetValue("Caption: " + sCaption);
var sText = oCharacters.GetText();
oWorksheet.GetRange("B4").SetValue("Text: " + sText);
var nCount = oCharacters.GetCount();
oWorksheet.GetRange("B5").SetValue("Number of characters: " + nCount);
var oParent = oCharacters.GetParent();
oParent.SetBorders("Bottom", "Thick", Api.CreateColorFromRGB(255, 111, 61));
oCharacters = oRange.GetCharacters(23, 4);
oCharacters.Insert("string");
oCharacters = oRange.GetCharacters(9, 4);
oCharacters.Delete();
builder.SaveFile("xlsx", "ApiCharacters.xlsx");
builder.CloseFile();CLASS ApiFont
new ApiFont()
Класс, содержащий атрибуты шрифта (имя шрифта, размер шрифта, цвет и т. д.).
Характеристики
| Название | Тип | Описание |
| Parent | ApiCharacters | Родительский объект указанного объекта шрифта. |
| Bold | логический | null | Свойство шрифта полужирный. |
| Italic | логический | null | Свойство шрифта курсив. |
| Size | числовой | null | Свойство размера шрифта. |
| Strikethrough | логический | null | Свойство зачеркивания шрифта. |
| Underline | массив | null | Тип шрифта подчеркивания. |
| Subscript | логический | null | Свойство индекса шрифта. |
| Superscript | логический | null | Свойство верхнего индекса шрифта. |
| Name | строковый | null | Имя шрифта. |
| Color | ApiColor | null | Свойство цвета шрифта. |
Методы
METHOD GetBold
Возвращает свойство полужирного шрифта указанного шрифта.
METHOD GetColor
Возвращает свойство цвета указанного шрифта.
METHOD GetItalic
Возвращает свойство курсива указанного шрифта.
METHOD GetName
Возвращает свойство имени шрифта указанного шрифта.
METHOD GetParent
Возвращает родительский объект ApiCharacters указанного шрифта.
METHOD GetSize
Возвращает свойство размера шрифта указанного шрифта.
METHOD GetStrikethrough
Возвращает свойство зачеркивания указанного шрифта.
METHOD GetSubscript
Возвращает свойство индекса указанного шрифта.
METHOD GetSuperscript
Возвращает свойство верхнего индекса указанного шрифта.
METHOD GetUnderline
Возвращает тип подчеркивания, примененный к указанному шрифту.
METHOD SetBold
Устанавливает свойство полужирного шрифта для указанного шрифта.
METHOD SetColor
Устанавливает для свойства цвета шрифта указанный шрифт.
METHOD SetItalic
Устанавливает свойство курсива для указанного шрифта.
METHOD SetName
Устанавливает для свойства имени шрифта указанный шрифт.
METHOD SetSize
Устанавливает для свойства размера шрифта указанный шрифт.
METHOD SetStrikethrough
Устанавливает свойство зачеркивания для указанного шрифта.
METHOD SetSubscript
Устанавливает свойство индекса для указанного шрифта.
METHOD SetSuperscript
Устанавливает свойство superscript для указанного шрифта.
METHOD SetUnderline
Устанавливает подчеркивание типа, указанного в запросе, для текущего шрифта.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oRange = oWorksheet.GetRange("B1");
oRange.SetValue("This is just a sample text.");
var oCharacters = oRange.GetCharacters(23, 6);
var oFont = oCharacters.GetFont();
var oParent = oFont.GetParent();
oParent.SetText("string");
oFont.SetSize(18);
oFont.SetStrikethrough(true);
oFont.SetName("Font 1");
oFont.SetItalic(true);
var sFontName = oFont.GetName();
oWorksheet.GetRange("B3").SetValue("Font name: " + sFontName);
var nSize = oFont.GetSize();
oWorksheet.GetRange("B4").SetValue("Size property: " + nSize);
var bStrikethrough = oFont.GetStrikethrough();
oWorksheet.GetRange("B5").SetValue("Strikethrough property: " + bStrikethrough);
var bItalic = oFont.GetItalic();
oWorksheet.GetRange("B9").SetValue("Italic property: " + bItalic);
oCharacters = oRange.GetCharacters(9, 4);
oFont = oCharacters.GetFont();
oFont.SetSubscript(true);
var bSubscript = oFont.GetSubscript();
oWorksheet.GetRange("B6").SetValue("Subscript property: " + bSubscript);
var oColor = Api.CreateColorFromRGB(255, 111, 61);
oFont.SetColor(oColor);
oColor = oFont.GetColor();
oCharacters = oRange.GetCharacters(16, 6);
oFont = oCharacters.GetFont();
oFont.SetColor(oColor);
oCharacters = oRange.GetCharacters(6, 2);
oFont = oCharacters.GetFont();
oFont.SetSuperscript(true);
oFont.SetUnderline("xlUnderlineStyleSingle");
oFont.SetBold(true);
var bSuperscript = oFont.GetSuperscript();
oWorksheet.GetRange("B7").SetValue("Superscript property: " + bSuperscript);
var sUnderline = oFont.GetUnderline();
oWorksheet.GetRange("B8").SetValue("Underline property: " + sUnderline);
var bBold = oFont.GetBold();
oWorksheet.GetRange("B10").SetValue("Bold property: " + bBold);
builder.SaveFile("xlsx", "ApiFont.xlsx");
builder.CloseFile(); CLASS Api
new Api()
Базовый класс.
Характеристики
| Название | Тип | Описание |
| Sheets | Array | Возвращает коллекцию листов, представляющую все листы активной книги. |
| ActiveSheet | ApiWorksheet | Возвращает объект, представляющий активный лист. |
| Selection | ApiRange | Возвращает объект, представляющий выбранный диапазон. |
| Comments | Array | Возвращает массив объектов ApiComment. |
Методы
METHOD AddDefName
Добавляет новое имя в диапазон ячеек.
METHOD AddSheet
Создает новый рабочий лист.
METHOD attachEvent
Подписывается на указанное событие и вызывает функцию обратного вызова при возникновении события.
METHOD CreateBlipFill
Создает заливку метками для применения к объекту, используя выбранное изображение в качестве фона объекта.
METHOD CreateBullet
Создает пулю для абзаца с символом или знаком, указанным в параметре sSymbol.
METHOD CreateColorByName
Создает цвет, выбирая его из одной из доступных цветовых предустановок.
METHOD CreateColorFromRGB
Создает цвет RGB, устанавливая соответствующие значения для красного, зеленого и синего компонентов цвета.
METHOD CreateGradientStop
Создает ограничитель градиента, используемый для различных типов градиентов.
METHOD CreateLinearGradientFill
Создает линейную градиентную заливку для применения к объекту, используя выбранный линейный градиент в качестве фона объекта.
METHOD CreateNewHistoryPoint
Создает новую точку истории.
METHOD CreateNoFill
Создает отсутствие заливки и удаляет заливку из элемента.
METHOD CreateNumbering
Создает пулю для абзаца с нумерационным символом или символом, указанным в параметре sType.
METHOD CreateParagraph
Создает новый абзац.
METHOD CreatePatternFill
Создает заливку узором для применения к объекту, используя выбранный узор в качестве фона объекта.
METHOD CreatePresetColor
Создает цвет, выбирая его из одной из доступных цветовых предустановок.
METHOD CreateRadialGradientFill
Создает радиальную градиентную заливку для применения к объекту, используя выбранный радиальный градиент в качестве фона объекта.
METHOD CreateRGBColor
Создает цвет RGB, устанавливая соответствующие значения для красного, зеленого и синего компонентов цвета.
METHOD CreateRun
Создает новый текстовый блок меньшего размера для вставки в текущий абзац или таблицу.
METHOD CreateSchemeColor
Создает сложную цветовую схему, выбирая одну из доступных схем.
METHOD CreateSolidFill
Создает сплошную заливку для применения к объекту, используя выбранный сплошной цвет в качестве фона объекта.
METHOD CreateStroke
Создает обводку, добавляя тени к элементу.
METHOD CreateTextPr
Создает свойства пустого текста.
METHOD detachEvent
Отменяет подписку на указанное событие.
METHOD Format
Возвращает класс, отформатированный в соответствии с инструкциями, содержащимися в выражении format.
METHOD GetActiveSheet
Возвращает объект, представляющий активный лист.
METHOD GetComments
Возвращает массив объектов ApiComment.
METHOD GetDefName
Возвращает объект ApiName по имени диапазона.
METHOD GetFullName
Возвращает полное имя открытого в данный момент файла.
METHOD GetLocale
Возвращает идентификатор текущей локали.
METHOD GetMailMergeData
Возвращает данные о слиянии писем.
METHOD GetRange
Возвращает объект ApiRange по ссылке на диапазон.
METHOD GetRangeByNumber
Возвращает объект, который представляет диапазон указанного листа, используя максимальные и минимальные координаты строки/столбца.
METHOD GetSelection
Возвращает объект, представляющий выбранный диапазон.
METHOD GetSheet
Возвращает объект, представляющий лист.
METHOD GetSheets
Возвращает коллекцию листов, представляющую все листы в активной книге.
METHOD GetThemesColors
Возвращает список всех доступных цветов тем для электронной таблицы.
METHOD Intersect
Возвращает объект ApiRange, представляющий прямоугольное пересечение двух или более диапазонов.
METHOD onWorksheetChange
Функция обратного вызова, которая вызывается при изменении заданного диапазона текущего листа.
METHOD onWorksheetChange
Функция обратного вызова, которая вызывается при изменении указанного диапазона текущего листа.
METHOD RecalculateAllFormulas
Пересчитывает все формулы в активной книге.
METHOD ReplaceTextSmart
Заменяет каждый абзац (или текст в ячейке) при выборе соответствующим текстом из массива строк.
METHOD Save
Сохраняет изменения в указанном документе.
METHOD SetLocale
Задает локаль для документа.
METHOD SetThemeColors
Устанавливает цвета темы для текущей электронной таблицы.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oFillColor = Api.CreateColorFromRGB(201, 222, 255);
oWorksheet.GetRange("A1:M6").SetFillColor(oFillColor);
oWorksheet.GetRange("A1:M6").SetBold(true);
oWorksheet.GetRange("A7:A11").SetBold(true);
oWorksheet.GetRange("A21:M22").SetFillColor(oFillColor);
oFillColor = Api.CreateColorFromRGB(232, 240, 252);
oWorksheet.GetRange("A1").SetColumnWidth(14);
oWorksheet.GetRange("B1:M1").SetColumnWidth(7);
oWorksheet.GetRange("A1:A4").SetRowHeight(27);
var oImage = oWorksheet.AddImage("https://TEST_URL/examples/api-cell.png", 28 * 36000, 28 * 36000, 5, 0, 0, 0);
var oRange = oWorksheet.GetRange("C4:J4");
oRange.Merge(false);
oRange.SetValue("Annual Results");
oRange.SetFontSize(24);
oRange = oWorksheet.GetRange("C5:J5");
oRange.Merge(false);
oRange.SetValue("(in thousands of USD)");
oRange.SetFontSize(12);
oRange = oWorksheet.GetRange("C4:J5");
oRange.SetAlignHorizontal("center");
oRange.SetFontColor(Api.CreateColorFromRGB(64, 135, 247));
oRange.SetBorders("Top", "Thick", Api.CreateColorFromRGB(64, 135, 247));
oWorksheet.GetRange("A4:M5").SetBorders("Bottom", "Thick", Api.CreateColorFromRGB(64, 135, 247));
for (var i = 8; i <= 10; i++) {
if (i%2 === 0) {
oRange = oWorksheet.GetRange(`A${i}:M${i}`);
oRange.SetFillColor(oFillColor);
}
}
oWorksheet.GetRange("A6:M10").SetValue([
["City/Month", "Jan", "Feb", "Mar", "Apr", "May", "June", "July", "Aug", "Sept", "Oct", "Nov", "Dec"],
["Beijing", 361.06, 484.37, 318.96, 230.41, 219.15, 229.92, 431.04, 224.24, 396.48, 373.76, 361.06, 419.46],
["Jinan", 382.77, 375.40, 439.87, 238.76, 138.84, 240.92, 388.12, 299.67, 326.89, 379.88, 382.77, 481.45],
["Haujou", 348.05, 399.41, 303.55, 311.43, 148.70, 219.52, 450.96, 270.40, 371.74, 378.89, 348.05, 501.98],
["Macau", 354.52, 366.52, 342.87, 382.48, 222.50, 304.50, 388.09, 233.51, 346.43, 392.74, 354.52, 468.08],
]);
oWorksheet.GetRange("B6:M10").SetAlignHorizontal("center");
oWorksheet.GetRange("B6:M10").SetNumberFormat("$#,##0");
oWorksheet.GetRange("G11:I15").SetValue([
["","=B6","=M6"],
["=A7","=B7","=M7"],
["=A8","=B8","=M8"],
["=A9","=B9","=M9"],
["=A10","=B10","=M10"]
]);
var sheetName = oWorksheet.GetName();
oWorksheet.GetRange("G11:I15").SetNumberFormat("$#,##0");
var oChart = oWorksheet.AddChart(`'${sheetName}'!$A$6:$M$10`, true, "lineNormal", 1, 100 * 36000, 50 * 36000, 0, 0, 10, 0);
oChart.SetTitle("Financial Overview (in thousands of USD)", 10);
oChart.SetLegendPos("left");
oChart = oWorksheet.AddChart(`'${sheetName}'!$G$11:$I$15`, true, "bar", 2, 100 * 36000, 50 * 36000, 6, 0, 10, 0);
oChart.SetTitle("Year start VS Year End (in thousands of USD)", 10);
oChart.SetLegendPos("left");
Api.Save();
builder.SaveFile("xlsx", "Api.xlsx");
builder.CloseFile();CLASS ApiAreas
new ApiAreas()
Класс, представляющий области.
Характеристики
| Название | Тип | Описание |
| Count | числовой | Возвращает значение, представляющее количество объектов в коллекции. |
| Parent | ApiRange | Возвращает родительский объект для указанной коллекции. |
Методы
METHOD GetCount
Возвращает значение, представляющее количество объектов в коллекции.
METHOD GetItem
Возвращает один объект из коллекции по его ID.
METHOD GetParent
Возвращает родительский объект для указанной коллекции.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oRange = oWorksheet.GetRange("B1:D1");
oRange.SetValue("1");
oRange.Select();
var oAreas = oRange.GetAreas();
var oParent = oAreas.GetParent();
var sType = oParent.GetClassType();
oRange = oWorksheet.GetRange('A4');
oRange.SetValue("The areas parent: ");
oRange.AutoFit(false, true);
oWorksheet.GetRange('B4').Paste(oParent);
oRange = oWorksheet.GetRange('A5');
oRange.SetValue("The type of the areas parent: ");
oRange.AutoFit(false, true);
oWorksheet.GetRange('B5').SetValue(sType);
var nCount = oAreas.GetCount();
oRange = oWorksheet.GetRange('A6');
oRange.SetValue("The number of ranges in the areas: ");
oRange.AutoFit(false, true);
oWorksheet.GetRange('B6').SetValue(nCount);
var oItem = oAreas.GetItem(1);
oRange = oWorksheet.GetRange('A7');
oRange.SetValue("The first item from the areas: ");
oRange.AutoFit(false, true);
oWorksheet.GetRange('B7').Paste(oItem);
builder.SaveFile("xlsx", "ApiAreas.xlsx");
builder.CloseFile();CLASS ApiBullet
new ApiBullet()
Класс, представляющий маркер абзаца.
Методы
METHOD GetClassType
Возвращает родительский объект для указанной коллекции.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oFill = Api.CreateSolidFill(Api.CreateRGBColor(255, 111, 61));
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oShape = oWorksheet.AddShape("flowChartOnlineStorage", 120 * 36000, 35 * 36000, oFill, oStroke, 0, 2 * 36000, 0, 3 * 36000);
var oDocContent = oShape.GetContent();
var oParagraph = oDocContent.GetElement(0);
var oBullet = Api.CreateNumbering("ArabicParenR", 1);
oParagraph.SetBullet(oBullet);
oParagraph.AddText(" This is an example of the bulleted paragraph.");
oParagraph = Api.CreateParagraph();
oParagraph.SetBullet(oBullet);
oParagraph.AddText(" This is an example of the bulleted paragraph.");
oDocContent.Push(oParagraph);
var sClassType = oBullet.GetClassType();
oParagraph = Api.CreateParagraph();
oParagraph.SetJc("left");
oParagraph.AddText("Class Type = " + sClassType);
oDocContent.Push(oParagraph);
builder.SaveFile("xlsx", "ApiBullet.xlsx");
builder.CloseFile();CLASS ApiChart
new ApiChart()
Класс, представляющий диаграмму.
Методы
METHOD AddSeria
Добавляет новую серию в текущую диаграмму.
METHOD ApplyChartStyle
Устанавливает стиль текущей диаграммы по идентификатору стиля.
METHOD GetClassType
Возвращает тип класса ApiChart.
METHOD RemoveSeria
Удаляет заданную серию из текущего графика.
METHOD SetAxieNumFormat
Задает указанный числовой формат для значений оси.
METHOD SetCatFormula
Устанавливает диапазон значений категории для текущей диаграммы.
METHOD SetDataPointFill
Задает заливку точки данных в указанной серии диаграммы.
METHOD SetDataPointOutLine
Задает структуру для точки данных в указанной серии диаграммы.
METHOD SetHorAxisLablesFontSize
Задает размер шрифта для меток по горизонтальной оси.
METHOD SetHorAxisMajorTickMark
Указывает основную отметку деления для горизонтальной оси.
METHOD SetHorAxisMinorTickMark
Определяет второстепенную метку для горизонтальной оси.
METHOD SetHorAxisOrientation
Указывает направление данных, отображаемых на горизонтальной оси.
METHOD SetHorAxisTickLabelPosition
Задает возможные значения положения меток делений диаграммы относительно основной горизонтальной метки или значений данных диаграммы.
METHOD SetHorAxisTitle
Задает заголовок горизонтальной оси диаграммы.
METHOD SetLegendFill
Задает заливку легенды диаграммы.
METHOD SetLegendFontSize
Задает размер шрифта легенды.
METHOD SetLegendOutLine
Задает контур легенды диаграммы.
METHOD SetLegendPos
Указывает положение легенды диаграммы.
METHOD SetMajorHorizontalGridlines
Задает визуальные свойства основной горизонтальной линии сетки.
METHOD SetMajorVerticalGridlines
Задает визуальные свойства основной вертикальной линии сетки.
METHOD SetMarkerFill
Устанавливает заливку для маркера в указанной серии диаграммы.
METHOD SetMarkerOutLine
Устанавливает контур маркера в указанной серии диаграммы.
METHOD SetMinorHorizontalGridlines
Определяет визуальные свойства второстепенной вертикальной линии сетки.
METHOD SetMinorVerticalGridlines
Определяет визуальные свойства второстепенной вертикальной линии сетки.
METHOD SetPlotAreaFill
Устанавливает заливку для области графика.
METHOD SetPlotAreaOutLine
Задает контур области построения диаграммы.
METHOD SetSeriaName
Устанавливает имя для указанной серии.
METHOD SetSeriaValues
Устанавливает значения из указанного диапазона в указанную серию.
METHOD SetSeriaXValues
Устанавливает значения оси x из указанного диапазона в указанную серию. Используется только с диаграммами рассеяния.
METHOD SetSeriesFill
Устанавливает заливку для указанной серии графиков.
METHOD SetSeriesOutLine
Устанавливает контур для указанной серии графиков.
METHOD SetShowDataLabels
Определяет, какие метки данных диаграммы будут отображаться на графике.
METHOD SetShowPointDataLabel
Определяет параметры отображения меток данных.
METHOD SetTitle
Задает заголовок графика с указанными параметрами.
METHOD SetTitleFill
Устанавливает заливку заголовка графика.
METHOD SetTitleOutLine
Устанавливает контур к заголовку графика.
METHOD SetVerAxisOrientation
Определяет направление данных, отображаемых на вертикальной оси.
METHOD SetVerAxisTitle
Указывает заголовок вертикальной оси графика.
METHOD SetVertAxisLablesFontSize
Определяет размер шрифта для меток вертикальной оси.
METHOD SetVertAxisMajorTickMark
Указывает основную метку для вертикальной оси.
METHOD SetVertAxisMinorTickMark
Определяет второстепенную метку для вертикальной оси.
METHOD SetVertAxisTickLabelPosition
Задает возможные значения положения меток делений диаграммы относительно основной вертикальной метки или значений данных диаграммы.
Пример использования
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, 5, 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);
builder.SaveFile("xlsx", "ApiChart.xlsx");
builder.CloseFile();CLASS ApiColor
Методы
METHOD GetClassType
Возвращает тип класса ApiColor.
CLASS ApiComment
new ApiComment()
Класс, представляющий комментарий.
Характеристики
| Название | Тип | Описание |
| Text | строковый | Возвращает текст из первой ячейки диапазона. |
Методы
METHOD Delete
Удаляет объект ApiComment.
METHOD GetClassType
Возвращает тип класса ApiComment
METHOD GetText
Возвращает текст комментария.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
oWorksheet.GetRange("A1").SetValue("1");
var oRange = oWorksheet.GetRange("A1");
oRange.AddComment("This is just a number.");
var oComment = oRange.GetComment();
oWorksheet.GetRange("A3").SetValue("Comment: " + oComment.GetText());
var sType = oComment.GetClassType();
oWorksheet.GetRange("A4").SetValue("Type: " + sType + " (number of comment data type)");
builder.SaveFile("xlsx", "ApiComment.xlsx");
builder.CloseFile(); CLASS ApiDocument
new ApiDocument()
Класс, представляющий документ.
Методы
METHOD AddElement
Унаследовано от: ApiDocumentContent#AddElement.
Добавляет абзац, таблицу или элемент управления содержимым blockLvl, используя его положение в содержимом документа.
METHOD GetElement
Унаследовано от: ApiDocumentContent#GetElement.
Возвращает элемент по его позиции в документе.
METHOD GetElementsCount
Унаследованный от: ApiDocumentContent#GetElementsCount.
Возвращает количество элементов в текущем документе.
METHOD Push
Унаследованный от: ApiDocumentContent#Push.
Пушит изменения в абзац или таблицу, чтобы фактически добавить их в документ.
METHOD RemoveAllElements
Унаследованный от: ApiDocumentContent#RemoveAllElements.
Удаляет все элементы из текущего документа или из элемента текущего документа.
METHOD RemoveElement
Унаследованный от: ApiDocumentContent#RemoveElement.
Удаляет элемент, используя заданную позицию.
CLASS ApiDocumentContent
new ApiDocumentContent()
Класс, представляющий контейнер для абзацев и таблиц.
Методы
METHOD AddElement
Добавляет абзац, таблицу или элемент управления содержимым blockLvl, используя его позицию в содержимом документа.
METHOD GetClassType
Возвращает тип класса ApiGradientContent.
METHOD GetElement
Возвращает элемент по его положению в документе.
METHOD GetElementsCount
Возвращает количество элементов в текущем документе.
METHOD Push
Пушит изменения в абзац или таблицу, чтобы фактически добавить их в документ.
METHOD RemoveAllElements
Удаляет все элементы из текущего документа или из элемента текущего документа.
METHOD RemoveElement
Удаляет элемент, используя указанную позицию.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oFill = Api.CreateSolidFill(Api.CreateRGBColor(255, 111, 61));
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oShape = oWorksheet.AddShape("flowChartOnlineStorage", 200 * 36000, 60 * 36000, oFill, oStroke, 0, 2 * 36000, 0, 3 * 36000);
var oDocContent = oShape.GetContent();
var oParagraph = oDocContent.GetElement(0);
oParagraph.AddText("This is paragraph #1.");
for (let nParaIncrease = 1; nParaIncrease < 5; ++nParaIncrease) {
oParagraph = Api.CreateParagraph();
oParagraph.AddText("This is paragraph #" + (nParaIncrease + 1) + ".");
oDocContent.Push(oParagraph);
}
oDocContent.RemoveElement(2);
oParagraph = Api.CreateParagraph();
oParagraph.AddText("We removed paragraph #3, check that out above.");
oDocContent.Push(oParagraph);
var sClassType = oDocContent.GetClassType();
oParagraph.AddLineBreak();
oParagraph.AddText("Class Type = " + sClassType);
oParagraph.AddLineBreak();
oParagraph.AddText("Number of elements inside the shape: " + oDocContent.GetElementsCount());
oParagraph.AddLineBreak();
builder.SaveFile("xlsx", "ApiDocumentContent.xlsx");
builder.CloseFile();CLASS ApiDrawing
new ApiDrawing()
Класс, представляющий графический объект.
Методы
METHOD GetClassType
Возвращает тип класса ApiDrawing.
METHOD GetHeight
Возвращает высоту текущего рисунка.
METHOD GetLockValue
Устанавливает значение блокировки на указанный тип блокировки текущего чертежа.
METHOD GetWidth
Возвращает ширину текущего рисунка.
METHOD SetLockValue
Устанавливает значение блокировки на указанный тип блокировки текущего чертежа.
METHOD SetPosition
Изменяет положение объекта рисования.
METHOD SetSize
Задает размер ограничивающей рамки объекта (изображение, фигура, диаграмма).
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oFill = Api.CreateSolidFill(Api.CreateRGBColor(255, 111, 61));
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oDrawing = oWorksheet.AddShape("flowChartOnlineStorage", 60 * 36000, 35 * 36000, oFill, oStroke, 0, 2 * 36000, 0, 3 * 36000);
oDrawing.SetSize(80 * 36000, 40 * 36000);
oDrawing.SetPosition(0, 2 * 36000, 2, 3 * 36000);
var sClassType = oDrawing.GetClassType();
oWorksheet.GetRange("A1").SetValue("Class Type = " + sClassType);
builder.SaveFile("xlsx", "ApiDrawing.xlsx");
builder.CloseFile();CLASS ApiFill
new ApiFill()
Класс, представляющий базовый класс для заполнения.
Методы
METHOD GetClassType
Возвращает тип класса ApiFill
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oGs1 = Api.CreateGradientStop(Api.CreateRGBColor(255, 213, 191), 0);
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 111, 61), 100000);
var 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, 1, 3 * 36000);
var sClassType = oFill.GetClassType();
oWorksheet.SetColumnWidth(0, 15);
oWorksheet.SetColumnWidth(1, 10);
oWorksheet.GetRange("A1").SetValue("Class Type = " + sClassType);
builder.SaveFile("xlsx", "ApiFill.xlsx");
builder.CloseFile();CLASS ApiGradientStop
new ApiGradientStop()
Класс, представляющий остановку градиента.
Методы
METHOD GetClassType
Возвращает тип класса ApiGradientStop.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oGs1 = Api.CreateGradientStop(Api.CreateRGBColor(255, 213, 191), 0);
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 111, 61), 100000);
var 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, 1, 3 * 36000);
var sClassType = oGs1.GetClassType();
oWorksheet.SetColumnWidth(0, 15);
oWorksheet.SetColumnWidth(1, 10);
oWorksheet.GetRange("A1").SetValue("Class Type = " + sClassType);
builder.SaveFile("xlsx", "ApiGradientStop.xlsx");
builder.CloseFile();CLASS ApiImage
new ApiImage()
Класс, представляющий изображение.
Методы
METHOD GetClassType
Возвращает тип класса ApiImage.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oImage = oWorksheet.AddImage("https://TEST_URL/docbuilder/examples/coordinate_aspects.png", 60 * 36000, 35 * 36000, 0, 2 * 36000, 2, 3 * 36000);
var sClassType = oImage.GetClassType();
oWorksheet.SetColumnWidth(0, 15);
oWorksheet.SetColumnWidth(1, 10);
oWorksheet.GetRange("A1").SetValue("Class Type = ");
oWorksheet.GetRange("B1").SetValue(sClassType);
builder.SaveFile("xlsx", "ApiImage.xlsx");
builder.CloseFile();CLASS ApiName
new ApiName()
Класс, представляющий изображение.
Характеристики
| Название | Описание | Описание |
| Name | строковый | Задает имя активному листу. |
| RefersTo | строковый | Возвращает или задает формулу, для которой определено имя. |
| RefersToRange | ApiRange | Возвращает объект ApiRange по ссылке. |
Методы
METHOD Delete
Удаляет объект DefName.
METHOD GetName
Возвращает тип класса ApiName.
METHOD GetRefersTo
Возвращает формулу, на которую ссылается заданное имя.
METHOD GetRefersToRange
Возвращает объект ApiRange по его имени.
METHOD SetName
Устанавливает строковое значение, представляющее имя объекта.
METHOD SetRefersTo
Задает формулу, на которую ссылается определенное имя.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
oWorksheet.GetRange("A1").SetValue("1");
oWorksheet.GetRange("B1").SetValue("2");
oWorksheet.GetRange("C1").SetValue("=SUM(A1:B1)");
Api.AddDefName("numbers", "Sheet1!$A$1:$B$1");
var oDefName = Api.GetDefName("numbers");
oDefName.SetName("summa");
oDefName.SetRefersTo("=SUM(A1:B1)");
var oNewDefName = Api.GetDefName("summa");
oWorksheet.GetRange("A3").SetValue("A new name of the range: " + oNewDefName.GetName());
oWorksheet.GetRange("A4").SetValue("The name 'summa' refers to the formula from the cell C1.");
oWorksheet.GetRange("A5").SetValue("Formula: " + oDefName.GetRefersTo());
builder.SaveFile("xlsx", "ApiName.xlsx");
builder.CloseFile();CLASS ApiOleObject
new ApiOleObject()
Класс, представляющий объект OLE.
Методы
METHOD GetApplicationId
Возвращает идентификатор приложения из текущего объекта OLE.
METHOD GetClassType
Возвращает тип класса ApiOleObject.
METHOD GetData
Возвращает строковые данные из текущего объекта OLE.
METHOD SetApplicationId
Устанавливает идентификатор приложения для текущего объекта OLE.
METHOD SetData
Устанавливает данные в текущий объект OLE.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oOleObject = oWorksheet.AddOleObject("https://TEST_URL/docbuilder/examples/ole-object-image.png", 130 * 36000, 90 * 36000, "https://youtu.be/TEST_URL", "asc.{38E022EA-AD92-45FC-B22B-49DF39746DB4}", 0, 2 * 36000, 4, 3 * 36000);
oOleObject.SetApplicationId("asc.{E5773A43-F9B3-4E81-81D9-CE0A132470E7}");
var sAppId = oOleObject.GetApplicationId();
oWorksheet.GetRange("A1").SetValue("The OLE object application ID: " + sAppId);
oOleObject.SetData("https://youtu.be/TEST_URL");
var sData = oOleObject.GetData();
oWorksheet.GetRange("A2").SetValue("The OLE object data: " + sData);
var sType = oOleObject.GetClassType();
oWorksheet.GetRange("A3").SetValue("Class type: " + sType);
builder.SaveFile("xlsx", "ApiOleObject.xlsx");
builder.CloseFile();CLASS ApiParagraph
new ApiParagraph()
Класс, представляющий абзац.
Методы
METHOD AddElement
Добавляет элемент в текущий абзац.
METHOD AddLineBreak
Добавляет перевод строки к текущей позиции и начинает следующий элемент с новой строки.
METHOD AddTabStop
Добавляет остановку табуляции к текущему абзацу.
METHOD AddText
Добавляет текст к текущему абзацу.
METHOD Copy
Создает копию абзаца. Игнорирует комментарии, ссылки на сноски, сложные поля.
METHOD Delete
Удаляет текущий абзац.
METHOD GetClassType
Возвращает тип класса ApiParagraph.
METHOD GetElement
Возвращает элемент абзаца, используя указанную позицию.
METHOD GetElementsCount
Возвращает количество элементов в текущем абзаце.
METHOD GetIndFirstLine
Унаследованный от: ApiParaPr.GetIndFirstLine.
Возвращает отступ первой строки абзаца.
METHOD GetIndLeft
Унаследованный от: ApiParaPr.GetIndLeft.
Возвращает левый боковой отступ абзаца.
METHOD GetIndRight
Унаследованный от: ApiParaPr.GetIndRight.
Возвращает правый боковой отступ абзаца.
METHOD GetJc
Унаследованный от: ApiParaPr.GetJc.
Возвращает выравнивание содержимого абзаца.
METHOD GetNext
Возвращает следующий абзац.
METHOD GetParaPr
Возвращает свойства абзаца.
METHOD GetPrevious
Возвращает предыдущий абзац.
METHOD GetSpacingAfter
Унаследованный от: ApiParaPr.GetSpacingAfter.
Возвращает интервал после значения текущего абзаца.
METHOD GetSpacingBefore
Унаследованный от: ApiParaPr.GetSpacingBefore.
Возвращает интервал перед значением текущего абзаца.
METHOD GetSpacingLineRule
Унаследованный от: ApiParaPr.GetSpacingLineRule.
Возвращает правило межстрочного интервала абзаца.
METHOD GetSpacingLineValue
Унаследованный от: ApiParaPr.GetSpacingLineValue.
Возвращает значение межстрочного интервала абзаца.
METHOD RemoveAllElements
Удаляет все элементы из текущего абзаца.
METHOD RemoveElement
Удаляет элемент, используя указанную позицию.
METHOD SetBullet
Унаследовано от: ApiParaPr#SetBullet.
Устанавливает буллит или нумерацию для текущего абзаца.
METHOD SetIndFirstLine
Унаследованный от: ApiParaPr.SetIndFirstLine.
Устанавливает отступ первой строки абзаца.
METHOD SetIndLeft
Унаследованный от: ApiParaPr.SetIndLeft.
Устанавливает отступ слева от абзаца.
METHOD SetIndRight
Унаследованный от: ApiParaPr.SetIndRight.
Устанавливает отступ справа от абзаца.
METHOD SetJc
Унаследовано от: ApiParaPr#SetJc.
Устанавливает выравнивание содержимого абзаца.
METHOD SetSpacingAfter
Унаследованный от: ApiParaPr.SetSpacingAfter.
Устанавливает интервал после текущего абзаца.
METHOD SetSpacingBefore
Унаследованный от: ApiParaPr.SetSpacingBefore.
Устанавливает интервал перед текущим абзацем.
METHOD SetSpacingLine
Унаследованный от: ApiParaPr.SetSpacingLine.
Устанавливает межстрочный интервал абзаца.
METHOD SetTabs
Унаследованный от: ApiParaPr.SetTabs.
Указывает последовательность пользовательских позиций табуляции, которые будут использоваться для любых символов табуляции в текущем абзаце.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oFill = Api.CreateSolidFill(Api.CreateRGBColor(255, 111, 61));
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oShape = oWorksheet.AddShape("flowChartOnlineStorage", 130 * 36000, 60 * 36000, oFill, oStroke, 0, 2 * 36000, 0, 3 * 36000);
var oDocContent = oShape.GetContent();
var oParagraph = oDocContent.GetElement(0);
var oRun = Api.CreateRun();
oRun.AddText("Number of paragraph elements at this point: ");
oRun.AddTabStop();
oRun.AddText("" + oParagraph.GetElementsCount());
oRun.AddLineBreak();
oParagraph.AddElement(oRun);
oRun = oParagraph.GetElement(1);
oRun.SetBold(true);
oParagraph.AddLineBreak();
oParagraph.AddText("This is a paragraph with the text in it aligned by the center. ");
oParagraph.SetJc("center");
var oParagraph1 = Api.CreateParagraph();
oParagraph1.AddText("This is just a sample text. After it a tab stop will be added.");
oParagraph1.AddTabStop();
oParagraph1.AddText("This is the text which starts after the tab stop.");
oParagraph1.AddText("These sentences are used to add lines for demonstrative purposes.");
oParagraph1.SetIndFirstLine(1440);
oDocContent.Push(oParagraph1);
var oParagraph2 = Api.CreateParagraph();
var nIndFirstLine = oParagraph1.GetIndFirstLine();
oParagraph2.AddText("First line indent: " + nIndFirstLine);
oDocContent.Push(oParagraph2);
var oParagraph3 = Api.CreateParagraph();
var sClassType = oParagraph3.GetClassType();
oParagraph3.AddLineBreak();
oParagraph3.AddText("Class Type = " + sClassType);
oDocContent.Push(oParagraph3);
var oNextParagraph = oParagraph2.GetNext();
oNextParagraph.SetBold(true);
var oPreviousParagraph = oParagraph3.GetPrevious();
oPreviousParagraph.SetItalic(true);
builder.SaveFile("xlsx", "ApiParagraph.xlsx");
builder.CloseFile();CLASS ApiParaPr
new ApiParaPr()
Класс, представляющий свойства абзаца.
Методы
METHOD GetClassType
Возвращает тип класса ApiParaPr.
METHOD GetIndFirstLine
Возвращает отступ первой строки абзаца.
METHOD GetIndLeft
Возвращает отступ слева от абзаца.
METHOD GetIndRight
Возвращает отступ справа от абзаца.
METHOD GetJc
Возвращает выравнивание содержимого абзаца.
METHOD GetSpacingAfter
Возвращает значение интервала после текущего абзаца.
METHOD GetSpacingBefore
Возвращает интервал перед значением текущего абзаца.
METHOD GetSpacingLineRule
Возвращает правило межстрочного интервала абзаца.
METHOD GetSpacingLineValue
Возвращает значение межстрочного интервала абзаца.
METHOD SetBullet
Устанавливает маркер или нумерацию для текущего абзаца.
METHOD SetIndFirstLine
Устанавливает отступ первой строки абзаца.
METHOD SetIndLeft
Устанавливает отступ слева от абзаца.
METHOD SetIndRight
Устанавливает правый боковой отступ абзаца.
METHOD SetJc
Устанавливает выравнивание содержимого абзаца.
METHOD SetSpacingAfter
Устанавливает интервал после текущего абзаца.
METHOD SetSpacingBefore
Устанавливает интервал перед текущим абзацем.
METHOD SetSpacingLine
Устанавливает межстрочный интервал абзаца.
METHOD SetTabs
Задает последовательность пользовательских ограничителей табуляции, которые будут использоваться для любых символов табуляции в текущем абзаце.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oFill = Api.CreateSolidFill(Api.CreateRGBColor(255, 111, 61));
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oShape = oWorksheet.AddShape("flowChartOnlineStorage", 120 * 36000, 70 * 36000, oFill, oStroke, 0, 2 * 36000, 0, 3 * 36000);
var oDocContent = oShape.GetContent();
var oParagraph = oDocContent.GetElement(0);
var oParaPr = oParagraph.GetParaPr();
oParagraph.AddText("This is a paragraph with the text in it aligned by the center. ");
oParaPr.SetJc("center");
oParaPr.SetIndFirstLine(1440);
var oParagraph1 = Api.CreateParagraph();
var nIndFirstLine = oParaPr.GetIndFirstLine();
oParagraph1.AddText("First line indent: " + nIndFirstLine);
oDocContent.Push(oParagraph1);
var oParagraph2 = Api.CreateParagraph();
var sClassType = oParaPr.GetClassType();
oParagraph2.AddText("Class Type = " + sClassType);
oDocContent.Push(oParagraph2);
builder.SaveFile("xlsx", "ApiParaPr.xlsx");
builder.CloseFile();CLASS ApiPresetColor
new ApiPresetColor()
Класс, представляющий предустановленный цвет.
Методы
METHOD GetClassType
Возвращает тип класса ApiPresetColor.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oPresetColor = Api.CreatePresetColor("peachPuff");
var oGs1 = Api.CreateGradientStop(oPresetColor, 0);
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 111, 61), 100000);
var 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, 1, 3 * 36000);
var sClassType = oPresetColor.GetClassType();
oWorksheet.SetColumnWidth(0, 15);
oWorksheet.SetColumnWidth(1, 10);
oWorksheet.GetRange("A1").SetValue("Class Type = ");
oWorksheet.GetRange("B1").SetValue(sClassType);
builder.SaveFile("xlsx", "ApiPresetColor.xlsx");
builder.CloseFile();CLASS ApiRange
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 для форматирования символов в текстовой строке. |
Методы
METHOD AddComment
Добавляет комментарий к текущему диапазону.
METHOD AutoFit
Изменяет ширину столбцов или высоту строк в диапазоне для достижения наилучшего соответствия.
METHOD Clear
Очищает текущий диапазон.
METHOD Copy
Копирует диапазон в указанный диапазон.
METHOD Delete
Удаляет объект Range.
METHOD End
Возвращает объект Range, представляющий конец в указанном направлении в указанном диапазоне.
METHOD Find
Находит конкретную информацию в текущем диапазоне.
METHOD FindNext
Продолжает поиск, начатый с помощью метода ApiRange#Find.
Находит следующую ячейку, соответствующую тем же условиям, и возвращает объект ApiRange, представляющий эту ячейку.
METHOD FindPrevious
Продолжает поиск, начатый с помощью метода ApiRange#Find.
Находит предыдущую ячейку, соответствующую тем же условиям, и возвращает объект ApiRange, представляющий эту ячейку.
METHOD ForEach
Выполняет предоставленную функцию один раз для каждой ячейки.
METHOD GetAddress
Возвращает адрес диапазона.
METHOD GetAreas
Возвращает коллекцию диапазонов.
METHOD GetCells
Возвращает объект Range, представляющий все ячейки в указанном диапазоне или указанную ячейку.
METHOD GetCharacters
Возвращает объект ApiCharacters, представляющий диапазон символов в тексте объекта.
METHOD GetClassType
Возвращает тип класса ApiSchemeColor.
METHOD GetCol
Возвращает номер столбца для выбранной ячейки.
METHOD GetCols
Возвращает объект Range, представляющий столбцы в указанном диапазоне.
METHOD GetColumnWidth
Возвращает значение ширины столбца.
METHOD GetComment
Возвращает объект ApiComment текущего диапазона.
METHOD GetCount
Возвращает количество строк или столбцов.
METHOD GetDefName
Возвращает объект ApiName текущего диапазона.
METHOD GetFillColor
Возвращает цвет фона для текущего диапазона ячеек. Возвращает «Нет заливки», когда цвет фона в ячейке/диапазоне ячеек равен нулю.
METHOD GetFormula
Возвращает формулу указанного диапазона.
METHOD GetHidden
Возвращает свойство скрытия значений. Указанный диапазон должен охватывать весь столбец или строку.
METHOD GetNumberFormat
Возвращает значение, представляющее код формата для текущего диапазона.
METHOD GetOrientation
Возвращает текущий угол диапазона.
METHOD GetRow
Возвращает номер строки для выбранной ячейки.
METHOD GetRowHeight
Возвращает значение высоты строки.
METHOD GetRows
Возвращает объект Range, представляющий строки в указанном диапазоне.
METHOD GetText
Возвращает текст заданного диапазона.
METHOD GetValue
Возвращает значение указанного диапазона.
METHOD GetValue2
Возвращает свойство Value2 (значение без формата) указанного диапазона.
METHOD GetWorksheet
Возвращает объект Worksheet, представляющий рабочий лист, содержащий указанный диапазон.
METHOD GetWrapText
Возвращает информацию о стиле ячейки упаковки.
METHOD Insert
Вставляет ячейку или диапазон ячеек в рабочий лист или лист макросов и сдвигает другие ячейки, чтобы освободить место.
METHOD Merge
Объединяет выбранный диапазон ячеек в одну ячейку или строку ячеек.
METHOD Paste
Вставляет объект Range в указанный диапазон.
METHOD Replace
Заменяет определенную информацию на другую в диапазоне.
METHOD Select
Выбирает текущий диапазон.
METHOD SetAlignHorizontal
Устанавливает горизонтальное выравнивание текста в текущем диапазоне ячеек.
METHOD SetAlignVertical
Устанавливает вертикальное выравнивание текста в текущем диапазоне ячеек.
METHOD SetBold
Задает свойство полужирного шрифта для текстовых символов в текущей ячейке или диапазоне ячеек.
METHOD SetBorders
Задает границу ячейки/диапазона ячеек с указанными параметрами.
METHOD SetColumnWidth
Задает ширину всех столбцов в текущем диапазоне.
METHOD SetFillColor
Задает цвет фона для текущего диапазона ячеек с ранее созданным цветовым объектом.
METHOD SetFontColor
Устанавливает цвет текста в текущем диапазоне ячеек с помощью ранее созданного цветового объекта.
METHOD SetFontName
Задает указанное семейство шрифтов в качестве имени шрифта для текущего диапазона ячеек.
METHOD SetFontSize
Устанавливает размер шрифта для символов текущего диапазона ячеек.
METHOD SetHidden
Задает свойство скрытия значения.
METHOD SetItalic
Задает свойство курсива для текстовых символов в текущей ячейке или диапазоне ячеек.
METHOD SetNumberFormat
Указывает, следует ли рассматривать число в ячейке как число, валюту, дату, время и т. д. или просто как текст.
METHOD SetOffset
Устанавливает смещение ячейки.
METHOD SetOrientation
Устанавливает угол для текущего диапазона ячеек.
METHOD SetRowHeight
Устанавливает значение высоты строки.
METHOD SetSort
Сортирует ячейки в заданном диапазоне по параметрам, указанным в запросе.
METHOD SetStrikeout
Указывает, что содержимое ячейки/диапазона ячеек отображается одной горизонтальной линией, проходящей через центр содержимого.
METHOD SetUnderline
Указывает, что содержимое текущей ячейки/диапазона ячеек отображается вместе со строкой, появляющейся непосредственно под символом.
METHOD SetValue
Устанавливает значение для текущей ячейки или диапазона ячеек.
METHOD SetWrap
Указывает, должны ли слова в ячейке переноситься, чтобы соответствовать размеру ячейки или нет.
METHOD 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();CLASS ApiRGBColor
new ApiRGBColor()
Класс, представляющий цвет RGB.
Методы
METHOD GetClassType
Возвращает тип класса ApiRGBColor.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oRGBColor = Api.CreateRGBColor(255, 213, 191);
var oGs1 = Api.CreateGradientStop(oRGBColor, 0);
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 111, 61), 100000);
var 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, 1, 3 * 36000);
var sClassType = oRGBColor.GetClassType();
oWorksheet.SetColumnWidth(0, 15);
oWorksheet.SetColumnWidth(1, 10);
oWorksheet.GetRange("A1").SetValue("Class Type = ");
oWorksheet.GetRange("B1").SetValue(sClassType);
builder.SaveFile("xlsx", "ApiRGBColor.xlsx");
builder.CloseFile();CLASS ApiRun
new ApiRun()
Класс, представляющий небольшой текстовый блок под названием «run».
Методы
METHOD AddLineBreak
Добавляет разрыв строки к текущей позиции запуска и начинает следующий элемент с новой строки.
METHOD AddTabStop
Добавляет остановку табуляции к текущему прогону.
METHOD AddText
Добавляет некоторый текст к текущему запуску.
METHOD ClearContent
Очищает содержимое текущего запуска.
METHOD Copy
Создает копию текущего запуска.
METHOD Delete
Удаляет текущий запуск.
METHOD GetClassType
Возвращает тип класса ApiRun.
METHOD GetFontNames
Возвращает все имена шрифтов из всех элементов внутри текущего запуска.
METHOD GetTextPr
Возвращает текстовые свойства текущего запуска.
METHOD RemoveAllElements
Удаляет все элементы из текущего запуска.
METHOD SetBold
Устанавливает свойство полужирного шрифта для текстового символа.
METHOD SetCaps
Указывает, что все символы нижнего регистра в текущем тексте форматируются для отображения только как эквиваленты символов заглавных букв.
METHOD SetColor
Задает цвет текста для текущего запуска текста в формате RGB.
METHOD SetDoubleStrikeout
Указывает, что содержимое текущего запуска отображается двумя горизонтальными линиями через каждый символ, отображаемый в строке.
METHOD SetFill
Устанавливает цвет текста в соответствии с текущим текстом.
METHOD SetFontFamily
Устанавливает все 4 слота шрифтов с указанным семейством шрифтов.
METHOD SetFontSize
Устанавливает размер шрифта для символов текущего текстового прогона.
METHOD SetHighlight
Задает цвет выделения, который применяется в качестве фона к содержимому текущего запуска.
METHOD SetItalic
Устанавливает свойство курсива для текстового символа.
METHOD SetLanguage
Указывает языки, которые будут использоваться для проверки орфографии и грамматики (если требуется) при обработке содержимого этого текстового прогона.
METHOD SetOutLine
Унаследованный от: ApiTextPr.SetOutLine.
Штрих, используемый для создания контура текста
METHOD SetPosition
Определяет величину, на которую текст поднимается или опускается для этого прогона по отношению к базовой линии по умолчанию для окружающего непозиционированного текста.
METHOD SetShd
Определяет затенение, которое будет применено к границам текущей ячейки в таблице.
METHOD SetSmallCaps
Указывает, что все символы строчных букв в этом тексте форматируются для отображения только в качестве эквивалентов символов заглавных букв, которые на два пункта меньше, чем фактический размер шрифта, указанный для этого текста.
METHOD SetSpacing
Устанавливает расстояние между текстами, измеряемое в двадцатых долях пункта.
METHOD SetStrikeout
Указывает, что содержимое текущего запуска отображается одной горизонтальной линией, проходящей через центр строки.
METHOD SetStyle
Устанавливает стиль для текущего прогона.
METHOD SetTextFill
Унаследованный от: ApiTextPr.SetTextFill.
Задает заливку текста текущим текстом.
METHOD SetTextPr
Задает свойства текста для текущего запуска.
METHOD SetUnderline
Указывает, что содержимое текущего запуска отображается вместе со строкой, расположенной непосредственно под символом (меньше, чем все интервалы над и под символами в строке).
METHOD SetVertAlign
Определяет выравнивание, которое будет применяться к содержимому текущего прогона по отношению к внешнему виду текстового прогона по умолчанию.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oFill = Api.CreateSolidFill(Api.CreateRGBColor(255, 111, 61));
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oShape = oWorksheet.AddShape("flowChartOnlineStorage", 120 * 36000, 70 * 36000, oFill, oStroke, 0, 2 * 36000, 0, 3 * 36000);
var oDocContent = oShape.GetContent();
var oParagraph = oDocContent.GetElement(0);
var oRun = Api.CreateRun();
oRun.AddText("This is the text for the first line. Nothing special.");
oRun.AddLineBreak();
oRun.AddText("This is the text which starts from the beginning of the second line. After it three tab stops will be added.");
oRun.AddTabStop();
oRun.AddTabStop();
oRun.AddTabStop();
oRun.AddText("This is the text which starts after the tab stops.");
oRun.SetItalic(true);
oParagraph.AddElement(oRun);
oRun = Api.CreateRun();
var oTextPr = oRun.GetTextPr();
oTextPr.SetFontSize(30);
oRun.AddText("This is just a sample text. ");
oRun.AddText("But you will not see it in the resulting document, as it will be cleared.");
oParagraph.AddElement(oRun);
oRun.ClearContent();
oParagraph = Api.CreateParagraph();
oRun = Api.CreateRun();
oRun.AddText("The text in the previous paragraph cannot be seen, as it has been cleared.");
oParagraph.AddElement(oRun);
oRun = Api.CreateRun();
oRun.AddLineBreak();
oRun.AddText("This is just a sample text that was copied.");
oParagraph.AddElement(oRun);
var oCopyRun = oRun.Copy();
oCopyRun.SetCaps(true);
oCopyRun.SetBold(true);
oCopyRun.SetFontSize(20);
var sClassType = oCopyRun.GetClassType();
oCopyRun.AddLineBreak();
oCopyRun.AddText("Class Type = " + sClassType);
oParagraph.AddElement(oCopyRun);
oDocContent.Push(oParagraph);
builder.SaveFile("xlsx", "ApiRun.xlsx");
builder.CloseFile();CLASS ApiSchemeColor
new ApiSchemeColor()
Класс, представляющий цвет схемы.
Методы
METHOD GetClassType
Возвращает тип класса ApiSchemeColor.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oSchemeColor = Api.CreateSchemeColor("dk1");
var oFill = Api.CreateSolidFill(oSchemeColor);
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
oWorksheet.AddShape("curvedUpArrow", 60 * 36000, 35 * 36000, oFill, oStroke, 0, 2 * 36000, 1, 3 * 36000);
var sClassType = oSchemeColor.GetClassType();
oWorksheet.SetColumnWidth(0, 15);
oWorksheet.SetColumnWidth(1, 10);
oWorksheet.GetRange("A1").SetValue("Class Type = ");
oWorksheet.GetRange("B1").SetValue(sClassType);
builder.SaveFile("xlsx", "ApiSchemeColor.xlsx");
builder.CloseFile();CLASS ApiShape
new ApiShape()
Класс, представляющий фигуру.
Методы
METHOD GetClassType
Возвращает тип класса ApiShape.
METHOD GetContent
Возвращает внутреннее содержимое формы, куда может быть вставлен абзац или текстовый прогон.
METHOD GetDocContent
Возвращает внутреннее содержимое формы, куда может быть вставлен абзац или текстовый прогон.
METHOD SetPaddings
Устанавливает отступы текста к текущей форме.
METHOD SetVerticalTextAlign
Устанавливает вертикальное выравнивание для содержимого формы, в которую можно вставить абзац или текстовые прогоны.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oFill = Api.CreateSolidFill(Api.CreateRGBColor(255, 111, 61));
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oShape = oWorksheet.AddShape("flowChartOnlineStorage", 60 * 36000, 50 * 36000, oFill, oStroke, 0, 2 * 36000, 0, 3 * 36000);
var oDocContent = oShape.GetContent();
oDocContent.RemoveAllElements();
oShape.SetVerticalTextAlign("bottom");
var oParagraph = Api.CreateParagraph();
oParagraph.SetJc("left");
oParagraph.AddText("We removed all elements from the shape and added a new paragraph inside it ");
oParagraph.AddText("aligning it vertically by the bottom.");
oDocContent.Push(oParagraph);
var sClassType = oShape.GetClassType();
oWorksheet.GetRange("A12").SetValue("Class Type = " + sClassType);
builder.SaveFile("xlsx", "ApiShape.xlsx");
builder.CloseFile();CLASS ApiStroke
new ApiStroke()
Класс, представляющий штрих.
Методы
METHOD GetClassType
Возвращает тип класса ApiStroke.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oGs1 = Api.CreateGradientStop(Api.CreateRGBColor(255, 213, 191), 0);
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 111, 61), 100000);
var 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, 1, 3 * 36000);
var sClassType = oStroke.GetClassType();
oWorksheet.SetColumnWidth(0, 15);
oWorksheet.SetColumnWidth(1, 10);
oWorksheet.GetRange("A1").SetValue("Class Type = ");
oWorksheet.GetRange("B1").SetValue(sClassType);
builder.SaveFile("xlsx", "ApiStroke.xlsx");
builder.CloseFile();CLASS ApiTextPr
new ApiTextPr()
Класс, представляющий свойства текста.
Методы
METHOD GetClassType
Возвращает тип класса ApiTextPr.
METHOD SetBold
Устанавливает свойство полужирного шрифта к текстовому символу.
METHOD SetCaps
Указывает, что любые символы нижнего регистра в текстовом прогоне форматируются для отображения только как их эквиваленты символов заглавных букв.
METHOD SetDoubleStrikeout
Указывает, что содержимое текущего запуска отображается с двумя горизонтальными линиями через каждый символ, отображаемый в строке.
METHOD SetFill
Устанавливает цвет текста в соответствии с текущим цветом текста.
METHOD SetFontFamily
Устанавливает все 4 слота шрифтов с указанным семейством шрифтов.
METHOD SetFontSize
Устанавливает размер шрифта для символов текущего текстового прогона.
METHOD SetItalic
Устанавливает свойство курсива для текстового символа.
METHOD SetOutLine
Устанавливает контур текста в текущий текстовый ряд.
METHOD SetSmallCaps
Указывает, что все символы строчных букв в текстовом прогоне форматируются для отображения только как их эквиваленты символов заглавных букв, которые на две точки меньше, чем фактический размер шрифта, указанный для этого текста.
METHOD SetSpacing
Устанавливает интервал между текстом, измеряемый в двадцатых долях пункта.
METHOD SetStrikeout
Указывает, что содержимое серии отображается одной горизонтальной линией, проходящей через центр строки.
METHOD SetTextFill
Устанавливает текстовую заливку для текущего прогона текста.
METHOD SetUnderline
Указывает, что содержимое строки отображается вместе со строкой, появляющейся непосредственно под символом (меньше, чем все интервалы над и под символами в строке).
METHOD SetVertAlign
Определяет выравнивание, которое будет применяться к содержимому прогона по отношению к внешнему виду текста цикла по умолчанию.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oFill = Api.CreateSolidFill(Api.CreateRGBColor(255, 111, 61));
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oShape = oWorksheet.AddShape("flowChartOnlineStorage", 120 * 36000, 70 * 36000, oFill, oStroke, 0, 2 * 36000, 0, 3 * 36000);
var oDocContent = oShape.GetContent();
var oParagraph = oDocContent.GetElement(0);
var oRun = Api.CreateRun();
var oTextPr = oRun.GetTextPr();
oTextPr.SetFontSize(30);
oTextPr.SetBold(true);
oTextPr.SetCaps(true);
oFill = Api.CreateSolidFill(Api.CreateRGBColor(128, 128, 128));
oTextPr.SetFill(oFill);
oTextPr.SetFontFamily("Comic Sans MS");
oParagraph.SetJc("left");
oRun.AddText("This is a sample text inside the shape with the font size set to 15 points using the text properties.");
oParagraph.AddElement(oRun);
var sClassType = oTextPr.GetClassType();
oRun.AddLineBreak();
oRun.AddText("Class Type = " + sClassType);
builder.SaveFile("xlsx", "ApiTextPr.xlsx");
builder.CloseFile();CLASS ApiUniColor
new ApiUniColor()
Класс, представляющий базовый класс для типов цвета.
Методы
METHOD GetClassType
Возвращает тип класса ApiUniColor.
Пример использования
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oPresetColor = Api.CreatePresetColor("peachPuff");
var oGs1 = Api.CreateGradientStop(oPresetColor, 0);
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 111, 61), 100000);
var 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, 1, 3 * 36000);
var sClassType = oPresetColor.GetClassType();
oWorksheet.SetColumnWidth(0, 15);
oWorksheet.SetColumnWidth(1, 10);
oWorksheet.GetRange("A1").SetValue("Class Type = ");
oWorksheet.GetRange("B1").SetValue(sClassType);
builder.SaveFile("xlsx", "ApiUniColor.xlsx");
builder.CloseFile();CLASS ApiWorksheet
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. |
Методы
METHOD AddChart
Создает диаграмму указанного типа из выбранного диапазона данных текущего листа.
METHOD AddDefName
Добавляет новое имя на текущий рабочий лист.
METHOD AddImage
Добавляет изображение на текущий лист с указанными параметрами.
METHOD AddOleObject
Добавляет объект OLE на текущий лист с указанными параметрами.
METHOD AddShape
Добавляет фигуру на текущий лист с указанными параметрами.
METHOD AddWordArt
Добавляет объект Text Art на текущий лист с указанными параметрами.
METHOD Delete
Удаляет текущий рабочий лист.
METHOD FormatAsTable
Форматирует выбранный диапазон ячеек из текущего листа в виде таблицы (с форматированием первой строки в виде заголовка).
METHOD GetActiveCell
Возвращает объект, представляющий активную ячейку.
METHOD GetAllCharts
Возвращает все диаграммы с текущего листа.
METHOD GetAllDrawings
Возвращает все рисунки с текущего листа.
METHOD GetAllImages
Возвращает все изображения с текущего листа.
METHOD GetAllOleObjects
Возвращает все объекты OLE с текущего листа.
METHOD GetAllShapes
Возвращает массив со всеми объектами фигур из макета слайда.
METHOD GetBottomMargin
Возвращает нижнее поле листа.
METHOD GetCells
Возвращает ApiRange, представляющий все ячейки на листе (а не только те ячейки, которые используются в данный момент).
METHOD GetCols
Возвращает объект ApiRange, представляющий все ячейки диапазона столбцов.
METHOD GetComments
Возвращает массив объектов ApiComment.
METHOD GetDefName
Возвращает объект ApiName по имени листа.
METHOD GetDefNames
Возвращает массив объектов ApiName.
METHOD GetIndex
Возвращает индекс листа.
METHOD GetLeftMargin
Возвращает левое поле листа.
METHOD GetName
Возвращает имя листа.
METHOD GetPageOrientation
Возвращает ориентацию страницы.
METHOD GetPrintGridlines
Возвращает свойство страницы PrintGridlines, которое указывает, должны ли быть напечатаны линии сетки текущего листа.
METHOD GetPrintHeadings
Возвращает свойство страницы PrintHeadings, которое указывает, должны ли печататься заголовки строк/столбцов текущего листа.
METHOD GetRange
Возвращает объект, представляющий выбранный диапазон текущего листа.
METHOD GetRangeByNumber
Возвращает объект, который представляет выбранный диапазон текущего листа, используя координаты строки/столбца для выбора ячейки.
METHOD GetRightMargin
Возвращает правое поле листа.
METHOD GetRows
Возвращает объект ApiRange, представляющий все ячейки в диапазоне строк.
METHOD GetSelection
Возвращает объект, представляющий выбранный диапазон.
METHOD GetTopMargin
Возвращает верхнее поле листа.
METHOD GetUsedRange
Возвращает объект ApiRange, представляющий используемый диапазон на указанном листе.
METHOD GetVisible
Возвращает состояние видимости листа.
METHOD Move
Перемещает текущий лист в другое место книги.
METHOD ReplaceCurrentImage
Заменяет текущее изображение новым.
METHOD SetActive
Делает текущий лист активным.
METHOD SetBottomMargin
Устанавливает нижнее поле листа.
METHOD SetColumnWidth
Задает ширину указанного столбца.
METHOD SetDisplayGridlines
Указывает, должны ли отображаться линии сетки текущего листа.
METHOD SetDisplayHeadings
Указывает, должны ли отображаться заголовки текущей строки/столбца листа.
METHOD SetHyperlink
Добавляет гиперссылку в указанный диапазон.
METHOD SetLeftMargin
Устанавливает левое поле листа.
METHOD SetName
Задает имя для текущего активного листа.
METHOD SetPageOrientation
Устанавливает ориентацию страницы.
METHOD SetPrintGridlines
Указывает, нужно ли печатать текущие линии сетки листа.
METHOD SetPrintHeadings
Указывает, нужно ли печатать заголовки строк/столбцов текущего листа.
METHOD SetRightMargin
Устанавливает правое поле листа.
METHOD SetRowHeight
Задает высоту указанной строки, измеренную в пунктах.
METHOD SetRowHeight
Задает высоту указанной строки, измеренную в пунктах.
METHOD SetTopMargin
Устанавливает верхнее поле листа.
METHOD SetTopMargin
Устанавливает верхнее поле листа.
METHOD 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(); Ссылка скопирована в буфер обмена