METHOD GetClassType
Returns a type of the ApiWatermarkSettings class.
API текстового документа
Начало работы с текстовым API
API Классы
CLASS ApiWatermarkSettings
new ApiWatermarkSettings()
Класс, представляющий настройки, используемые для создания водяного знака.
Методы
METHOD GetDirection
Возвращает направление водяного знака в документе.
METHOD GetImageHeight
Возвращает высоту изображения водяного знака в документе.
METHOD GetImageURL
Возвращает URL-адрес изображения водяного знака в документе.
METHOD GetImageWidth
Возвращает ширину изображения водяного знака в документе.
METHOD GetOpacity
Возвращает непрозрачность водяного знака в документе.
METHOD GetText
Возвращает текст водяного знака в документе.
METHOD GetTextPr
Возвращает текстовые свойства водяного знака в документе.
METHOD GetType
Возвращает тип водяного знака в документе.
METHOD SetDirection
Устанавливает направление водяного знака в документе.
METHOD SetImageSize
Устанавливает размер (ширину и высоту) изображения водяного знака в документе.
METHOD SetImageURL
Устанавливает URL-адрес изображения водяного знака в документе.
METHOD SetOpacity
Устанавливает непрозрачность водяного знака в документе.
METHOD SetText
Устанавливает текст водяного знака в документе.
METHOD SetTextPr
Устанавливает текстовые свойства водяного знака в документе.
METHOD SetType
Устанавливает тип водяного знака в документе.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
oDocument.InsertWatermark("Watermark", true);
var oSettings = oDocument.GetWatermarkSettings();
oSettings.SetType("image");
oSettings.SetImageURL("https://TEST_URL/examples/logo.png");
oSettings.SetImageSize(100 * 36000, 100 * 36000);
oSettings.SetDirection("horizontal");
oSettings.SetOpacity(100);
oDocument.SetWatermarkSettings(oSettings);
var sClassType = oSettings.GetClassType();
var sType = oSettings.GetType();
var sDirection = oSettings.GetDirection();
var nOpacity = oSettings.GetOpacity();
var sImage = oSettings.GetImageURL();
var nWidth = oSettings.GetImageWidth();
var nHeight = oSettings.GetImageHeight();
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("Class type: " + sClassType);
oParagraph.AddLineBreak();
oParagraph.AddText("Watermark type: " + sType);
oParagraph.AddLineBreak();
oParagraph.AddText("Watermark image URL: "+ sImage);
oParagraph.AddLineBreak();
oParagraph.AddText("Watermark direction: " + sDirection);
oParagraph.AddLineBreak();
oParagraph.AddText("Watermark opacity: "+ nOpacity);
oParagraph.AddLineBreak();
oParagraph.AddText("Watermark image width: "+ nWidth);
oParagraph.AddLineBreak();
oParagraph.AddText("Watermark image height: "+ nHeight);
builder.SaveFile("docx", "ApiWatermarkSettings.docx");
builder.CloseFile();CLASS API
new Api()
Базовый класс.
Методы
METHOD AddComment
Добавляет комментарий к указанному элементу документа или массиву Runs.
METHOD attachEvent
Подписывается на указанное событие и вызывает функцию обратного вызова при возникновении события.
METHOD ConvertDocument
Преобразует документ в Markdown или HTML текст.
METHOD CreateBlipFill
Создает заливку при применении к объекту, используя выбранное изображение в качестве фона объекта.
METHOD CreateBlockLvlSdt
Создает новый контейнер уровня блока.
METHOD CreateBullet
Создает маркер для абзаца со знаком или символом, указанным в параметре sSymbol.
METHOD CreateChart
Создает график с заданными параметрами.
METHOD CreateGradientStop
Создает градиентный ограничитель, используемый для различных типов градиентов.
METHOD CreateHyperlink
Создает новый текстовый блок гиперссылки для вставки в текущий абзац или таблицу.
METHOD CreateImage
Создает изображение с указанными параметрами.
METHOD CreateInlineLvlSdt
Создает новый встроенный контейнер.
METHOD CreateLinearGradientFill
Создает заливку линейным градиентом при применении к объекту с использованием выбранного линейного градиента в качестве фона объекта.
METHOD CreateNoFill
Не создает заливку и удаляет заливку из элемента.
METHOD CreateNumbering
Создает маркер для абзаца с символом или символом нумерации, указанным в параметре sType.
METHOD CreateOleObject
Создает OLE-объект с указанными параметрами.
METHOD CreateParagraph
Создает новый абзац.
METHOD CreatePatternFill
Создает заливку узором для применения к объекту с использованием выбранного узора в качестве фона объекта.
METHOD CreatePresetColor
Создает цвет, выбирая его из одного из доступных наборов цветов.
METHOD CreateRadialGradientFill
Создает радиальную градиентную заливку при применении к объекту, используя выбранный радиальный градиент в качестве фона объекта.
METHOD CreateRange
Создает диапазон элементов. Если вы не укажете начальную и конечную позиции, диапазон будет взят из всего элемента.
METHOD CreateRGBColor
Создает цвет RGB, устанавливая соответствующие значения для красного, зеленого и синего цветовых компонентов.
METHOD CreateRun
Создает новый текстовый блок меньшего размера для вставки в текущий абзац или таблицу.
METHOD CreateSchemeColor
Создает сложную цветовую схему, выбирая одну из доступных схем.
METHOD CreateShape
Создает фигуру с указанными параметрами.
METHOD CreateSolidFill
Создает сплошную заливку для применения к объекту с использованием выбранного сплошного цвета в качестве фона объекта.
METHOD CreateStroke
Создает обводку, добавляя тени к элементу.
METHOD CreateTable
Создает новую таблицу с указанным количеством строк и столбцов.
METHOD CreateTextPr
Создает свойства пустого текста.
METHOD CreateWordArt
Создает объект Text Art с указанными параметрами.
METHOD detachEvent
Отменяет подписку на указанное событие.
METHOD FromJSON
Преобразует указанный объект JSON в объект Document Builder соответствующего типа.
METHOD GetDocument
Возвращает основной документ.
METHOD GetMailMergeReceptionsCount
Возвращает количество приемов слияния писем.
Возвращает документ шаблона по слиянию писем.
METHOD LoadMailMergeData
Загружает данные для слияния почты.
METHOD MailMerge
Запускает процесс слияния почты.
METHOD ReplaceDocumentContent
Заменяет основное содержимое документа другим содержимым документа.
METHOD ReplaceTextSmart
Заменяет каждый абзац (или текст в ячейке) при выборе соответствующим текстом из массива строк.
METHOD Save
Сохраняет изменения в заданном документе.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oRun = Api.CreateRun();
oRun.AddText("This is an example for base class methods.");
oParagraph.AddElement(oRun);
oRun = Api.CreateRun();
oRun.AddText(" A paragraph and a numbered list were created.");
oParagraph.AddElement(oRun);
oRun = Api.CreateRun();
oRun.AddText(" Then a chart, a shape and a table were created. The result was saved to the document.");
oParagraph.AddElement(oRun);
oParagraph = Api.CreateParagraph();
var oDrawing = Api.CreateChart("bar3D", [
[200, 240, 280],
[250, 260, 280]
], ["Projected Revenue", "Estimated Costs"], [2014, 2015, 2016], 4051300, 2347595, 24);
oParagraph.AddDrawing(oDrawing);
oDocument.Push(oParagraph);
oParagraph = Api.CreateParagraph();
var oGs1 = Api.CreateGradientStop(Api.CreateRGBColor(255, 224, 204), 0);
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 164, 101), 100000);
var oFill = Api.CreateLinearGradientFill([oGs1, oGs2], 5400000);
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
oDrawing = Api.CreateShape("rect", 5930900, 395605, oFill, oStroke);
oParagraph.AddDrawing(oDrawing);
oDocument.Push(oParagraph);
var oTableStyle = oDocument.CreateStyle("CustomTableStyle", "table");
oTableStyle.SetBasedOn(oDocument.GetStyle("Bordered - Accent 5"));
var oTable = Api.CreateTable(3, 3);
oTable.SetWidth("percent", 100);
oTable.SetStyle(oTableStyle);
oDocument.Push(oTable);
Api.Save();
builder.SaveFile("docx", "Api.docx");
builder.CloseFile(); CLASS ApiBlockLvlSdt
new ApiBlockLvlSdt()
Класс, представляющий контейнер для содержимого документа.
Методы
METHOD AddCaption
Добавляет абзац заголовка после (или до) текущего элемента управления содержимым.
METHOD AddComment
Добавляет комментарий к текущему элементу управления содержимым блока.
METHOD AddElement
Добавляет абзац, таблицу или блок управления содержимым в текущий контейнер.
METHOD AddText
Добавляет текст к текущему элементу управления содержимым.
METHOD Delete
Удаляет элемент управления содержимым и его содержимое. Если значение keepContent равно true, содержимое не удаляется.
METHOD GetAlias
Возвращает атрибут псевдонима для текущего контейнера.
METHOD GetAllContentControls
Возвращает коллекцию объектов управления содержимым в текущем элементе управления содержимым.
METHOD GetAllDrawingObjects
Возвращает коллекцию объектов рисования в текущем элементе управления содержимым.
METHOD GetAllParagraphs
Возвращает коллекцию объектов абзаца в текущем элементе управления содержимым.
METHOD GetAllTablesOnPage
Возвращает коллекцию таблиц на заданной абсолютной странице.
METHOD GetClassType
Возвращает тип класса ApiBlockLvlSdt.
METHOD GetContent
Возвращает содержимое текущего контейнера.
METHOD GetLabel
Возвращает атрибут label для текущего контейнера.
METHOD GetLock
Возвращает тип блокировки текущего контейнера.
METHOD GetParentContentControl
Возвращает элемент управления содержимым, содержащий текущий элемент управления содержимым.
METHOD GetParentTable
Возвращает родительскую таблицу, содержащую графический объект.
METHOD GetParentTableCell
Возвращает ячейку таблицы, содержащую текущий элемент управления содержимым.
METHOD GetPlaceholderText
Возвращает плейсхолдер из текущего элемента управления содержимым.
METHOD GetPosInParent
Возвращает позицию элемента управления содержимым в рамках родительского элемента.
METHOD GetRange
Возвращает объект Range, представляющий часть документа, содержащуюся в указанном элементе управления содержимым.
METHOD GetTag
Возвращает атрибут тега для текущего контейнера.
METHOD Push
Пушит изменения в абзац, таблицу или элемент управления содержимым блока, чтобы фактически добавить его в текущий контейнер.
METHOD RemoveAllElements
Очищает содержимое от текущего элемента управления содержимым.
METHOD ReplaceByElement
Заменяет текущий элемент управления содержимым новым элементом.
METHOD Search
Выполняет поиск области объекта управления содержимым. Результаты поиска представляют собой набор объектов ApiRange.
METHOD Select
Выбирает текущий элемент управления содержимым.
METHOD SetAlias
Устанавливает атрибут псевдонима для текущего контейнера.
METHOD SetBackgroundColor
Устанавливает цвет фона для текущего элемента управления содержимым блока.
METHOD SetLabel
Псевдоним, который будет добавлен к текущему контейнеру.
METHOD SetLock
Устанавливает блокировку для текущего элемента управления текстовым содержимым блока.
METHOD SetPlaceholderText
Устанавливает плейсхолдер для текущего элемента управления содержимым.
METHOD SetTag
Устанавливает атрибут tag для текущего контейнера.
METHOD SetTextPr
Применяет настройки текста к содержимому элемента управления содержимым.
METHOD ToJSON
Преобразует объект ApiBlockLvlSdt в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oBlockLvlSdt = Api.CreateBlockLvlSdt();
oBlockLvlSdt.GetContent().GetElement(0).AddText("This is the first paragraph of the content control.");
var oContent = oBlockLvlSdt.GetContent();
var oParagraph = Api.CreateParagraph();
oParagraph.AddText("This is the second paragraph of the content control.");
oContent.AddElement(oParagraph);
oContent.Push(oParagraph);
oDocument.AddElement(0, oBlockLvlSdt);
var aParagraphs = oBlockLvlSdt.GetAllParagraphs();
aParagraphs[0].SetBold(true);
oBlockLvlSdt.Search("paragraph")[1].SetItalic(true);
oBlockLvlSdt.SetLabel("2147483647");
oBlockLvlSdt.SetLock("sdtContentLocked");
oBlockLvlSdt.SetAlias("№1");
oBlockLvlSdt.SetTag("This is a tag.");
var oLabel = oBlockLvlSdt.GetLabel();
var oLock = oBlockLvlSdt.GetLock();
var oAlias = oBlockLvlSdt.GetAlias();
var oTag = oBlockLvlSdt.GetTag();
var sClassType = oBlockLvlSdt.GetClassType();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Class type: " + sClassType);
oParagraph.AddLineBreak();
oParagraph.AddText("Lock type: " + oLock);
oParagraph.AddLineBreak();
oParagraph.AddText("Label: " + oLabel);
oParagraph.AddLineBreak();
oParagraph.AddText("Alias: " + oAlias);
oParagraph.AddLineBreak();
oParagraph.AddText("Tag: " + oTag);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiBlockLvlSdt.docx");
builder.CloseFile();CLASS ApiBullet
new ApiBullet()
Класс, представляющий маркер абзаца.
Методы
METHOD GetClassType
Возвращает тип класса ApiBullet.
CLASS ApiChart
new ApiChart()
Класс, представляющий график.
Методы
METHOD ApplyChartStyle
Устанавливает стиль текущей диаграммы по идентификатору стиля.
METHOD GetClassType
Возвращает тип класса ApiChart.
METHOD GetNextChart
Возвращает следующую встроенную диаграмму, если она существует
METHOD GetPrevChart
Возвращает предыдущую встроенную диаграмму, если она существует.
METHOD RemoveSeria
Удаляет заданную серию из текущего графика.
METHOD SetAxieNumFormat
Устанавливает указанный числовой формат для значений оси.
METHOD SetCategoryName
Задает имя для указанной категории диаграммы.
METHOD SetDataPointFill
Задает заливку точки данных в указанной серии диаграммы.
METHOD SetDataPointNumFormat
Задает указанный числовой формат для точки данных диаграммы.
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 SetSeriaNumFormat
Задает указанный числовой формат для серии диаграммы.
METHOD SetSeriaValues
Задает значения для указанной серии диаграммы.
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
Указывает положение галочек для вертикальной оси.
METHOD SetXValues
Задает значения по оси x для всех серий диаграмм.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oDrawing = Api.CreateChart("bar3D", [
[200, 240, 280],
[250, 260, 280]
], ["Projected Revenue", "Estimated Costs"], [2014, 2015, 2016], 4051300, 2347595, 24);
oDrawing.SetVerAxisTitle("USD In Hundred Thousands", 10);
oDrawing.SetHorAxisTitle("Year", 11);
oDrawing.SetLegendPos("bottom");
oDrawing.SetShowDataLabels(false, false, true, false);
oDrawing.SetTitle("Financial Overview", 13);
oParagraph.AddDrawing(oDrawing);
builder.SaveFile("docx", "ApiChart.docx");
builder.CloseFile();CLASS ApiCheckBoxForm
new ApiCheckBoxForm()
Класс, представляющий форму кнопки типа checkbox / radio.
Методы
METHOD Clear
Унаследованный от: ApiFormBase.Clear.
Очищает текущую форму.
METHOD Copy
Унаследованный от: ApiFormBase.Copy.
Копирует текущую форму (копирует вместе с формой, если она существует).
METHOD GetClassType
Унаследованный от: ApiFormBase.GetClassType.
Возвращает тип класса ApiFormBase.
METHOD GetFormKey
Унаследованный от: ApiFormBase.GetFormKey.
Возвращает текущий ключ формы.
METHOD GetFormType
Унаследованный от: ApiFormBase.GetFormType.
Возвращает тип текущей формы.
METHOD GetRadioGroup
Возвращает ключ группы переключателей, если текущий флажок является переключателем.
METHOD GetText
Унаследованный от: ApiFormBase.GetText.
Возвращает текст из текущей формы. Этот метод используется только для текстовых форм и форм со списком.
METHOD GetTextPr
Унаследованный от: ApiFormBase.GetTextPr.
Возвращает свойства текста из текущей формы. Этот метод используется только для текстовых форм и форм со списком.
METHOD GetTipText
Унаследованный от: ApiFormBase.GetTipText.
Возвращает текст подсказки текущей формы.
METHOD GetWrapperShape
Унаследованный от: ApiFormBase.GetWrapperShape.
Возвращает фигуру, в которой размещена форма, для управления положением и размером рамки формы фиксированного размера. Для встроенных форм будет возвращено нулевое значение.
METHOD IsChecked
Возвращает состояние текущего флажка (установлен или нет).
METHOD IsFixed
Унаследованный от: ApiFormBase.IsFixed.
Проверяет, имеет ли текущая форма фиксированный размер.
METHOD IsRadioButton
Проверяет, является ли текущий флажок переключателем.
METHOD IsRequired
Унаследованный от: ApiFormBase.IsRequired.
Проверяет, требуется ли текущая форма.
METHOD SetBackgroundColor
Унаследованный от: ApiFormBase.SetBackgroundColor.
Задает цвет фона для текущей формы.
METHOD SetBorderColor
Унаследованный от: ApiFormBase.SetBorderColor.
Устанавливает цвет границы для текущей формы.
METHOD SetChecked
Проверяет текущий флажок.
METHOD SetFormKey
Унаследованный от: ApiFormBase.SetFormKey.
Задает ключ для текущей формы.
METHOD SetPlaceholderText
Унаследованный от: ApiFormBase.SetPlaceholderText.
Устанавливает плейсхолдер в текущую форму. Невозможно установить флажок или переключатель.
METHOD SetRadioGroup
Устанавливает ключ группы радио на текущий флажок.
METHOD SetRequired
Унаследованный от: ApiFormBase.SetRequired.
Указывает, нужно ли требовать текущую форму.
METHOD SetTextPr
Унаследованный от: ApiFormBase.SetTextPr.
Задает свойства текста для текущей формы. Этот метод используется только для текстовых форм и полей со списком.
METHOD SetTipText
Унаследованный от: ApiFormBase.SetTipText.
Устанавливает текст подсказки в текущую форму.
METHOD ToFixed
Унаследованный от: ApiFormBase.ToFixed.
Преобразует текущую форму в форму фиксированного размера.
METHOD ToInline
Унаследованный от: ApiFormBase.ToInline.
Преобразует текущую форму во встроенную форму. Форма изображения не может быть преобразована во встроенную форму, это всегда объект фиксированного размера.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oCheckBoxForm = Api.CreateCheckBoxForm({
"tip": "Specify your marital status",
"required": true,
"placeholder": "Marital status",
"radio": true
});
oCheckBoxForm.SetRadioGroup("Marital status");
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oCheckBoxForm);
oParagraph.AddText(" Married");
oParagraph.AddLineBreak();
oCheckBoxForm = Api.CreateCheckBoxForm({
"tip": "Specify your marital status",
"required": true,
"placeholder": "Marital status",
"radio": true
});
oCheckBoxForm.SetRadioGroup("Marital status");
oParagraph.AddElement(oCheckBoxForm);
oParagraph.AddText(" Single");
var sRadioGroup = oCheckBoxForm.GetRadioGroup();
var bRadioButton = oCheckBoxForm.IsRadioButton();
oCheckBoxForm.SetChecked(true);
var bChecked = oCheckBoxForm.IsChecked();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("The second checkbox from this document is a radio button: " + bRadioButton);
oParagraph.AddLineBreak();
oParagraph.AddText("The second checkbox from this document is checked: " + bChecked);
oParagraph.AddLineBreak();
oParagraph.AddText("Radio group name of the radio buttons in this document: " + sRadioGroup);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiCheckBoxForm.docx");
builder.CloseFile(); CLASS ApiComboBoxForm
new ApiComboBoxForm()
Класс, представляющий форму поля со списком документа.
Методы
METHOD Clear
Унаследованный от: ApiFormBase#Clear.
Очищает текущую форму.
METHOD Copy
Унаследованный от: ApiFormBase.Copy.
Копирует текущую форму (копирует вместе с формой, если она существует).
METHOD GetClassType
Унаследованный от: ApiFormBase.GetClassType.
Возвращает тип класса ApiFormBase.
METHOD GetFormKey
Унаследованный от: ApiFormBase#GetFormKey.
Возвращает ключ текущей формы.
METHOD GetFormType
Унаследованный от: ApiFormBase#GetFormType.
Возвращает тип текущей формы.
METHOD GetListValues
Этот метод не имеет параметров.
METHOD GetText
Унаследованный от: ApiFormBase.GetText.
Возвращает текст из текущей формы.
METHOD GetTextPr
Унаследованный от: ApiFormBase#GetTextPr.
Возвращает свойства текста из текущей формы.
METHOD GetTipText
Унаследованный от: ApiFormBase#GetTipText.
Возвращает текст подсказки в текущей форме.
METHOD GetWrapperShape
Унаследованный от: ApiFormBase.GetWrapperShape.
Возвращает фигуру, в которой размещена форма, для управления положением и размером рамки формы фиксированного размера.
METHOD IsEditable
Проверяет, можно ли редактировать текст комбинированного окна.
METHOD IsFixed
Унаследованный от: ApiFormBase#IsFixed.
Проверяет, имеет ли текущая форма фиксированный размер.
METHOD IsRequired
Унаследованный от: ApiFormBase#IsRequired.
Проверяет, требуется ли текущая форма.
METHOD SelectListValue
Выбирает указанное значение из списка значений комбинированного списка.
METHOD SetBackgroundColor
Унаследованный от: ApiFormBase#SetBackgroundColor.
Задает цвет фона текущей формы.
METHOD SetBorderColor
Унаследованный от: ApiFormBase#SetBorderColor.
Задает цвет границы текущей формы.
METHOD SetFormKey
Унаследованный от: ApiFormBase#SetFormKey.
Устанавливает ключ для текущей формы.
METHOD SetListValues
Устанавливает значения списка для текущего комбобокса.
METHOD SetPlaceholderText
Унаследованный от : ApiFormBase#SetPlaceholderText
Устанавливает текст заполнителя в текущую форму.
METHOD SetRequired
Унаследованный от: ApiFormBase#SetRequired.
Указывает, требуется ли текущая форма.
METHOD SetText
Устанавливает текст для текущего комбобокса.
METHOD SetTextPr
Унаследованный от: ApiFormBase#SetTextPr.
Устанавливает свойства текста для текущей формы.
METHOD SetTipText
Унаследованный от: ApiFormBase#SetTipText.
Устанавливает текст подсказки для текущей формы.
METHOD ToFixed
Унаследованный от: ApiFormBase#ToFixed.
Преобразует текущую форму в форму фиксированного размера.
METHOD ToInline
Унаследованная от: ApiFormBase#ToInline
Преобразует текущую форму во встроенную форму.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oComboBoxForm = Api.CreateComboBoxForm({
"key": "Personal information",
"tip": "Choose your country",
"required": true,
"placeholder": "Country",
"editable": true,
"autoFit": false
});
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oComboBoxForm);
oComboBoxForm.SetListValues(["Latvia", "USA", "UK"]);
oComboBoxForm.SetText("France");
oComboBoxForm.SelectListValue("USA");
var aListValues = oComboBoxForm.GetListValues();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Combo box list values: ");
oParagraph.AddLineBreak();
for (let i = 0; i < aListValues.length; i++) {
oParagraph.AddText(aListValues[i]);
oParagraph.AddLineBreak();
}
var bEdit = oComboBoxForm.IsEditable();
oParagraph.AddLineBreak();
oParagraph.AddText("The first combo box from this document is editable: " + bEdit);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiComboBoxForm.docx");
builder.CloseFile();CLASS ApiComment
new ApiComment()
Класс для работы с комментариями.
Методы
METHOD AddReply
Добавляет ответ на комментарий.
METHOD Delete
Удаляет текущий комментарий из документа.
METHOD GetAutorName
Возвращает имя автора комментария.
METHOD GetClassType
Возвращает тип класса ApiComment.
METHOD GetId
Возвращает идентификатор текущего комментария.
METHOD GetQuoteText
Возвращает текст цитаты текущего комментария.
METHOD GetRepliesCount
Возвращает количество ответов на комментарии.
METHOD GetReply
Возвращает указанный ответ на комментарий.
METHOD GetText
Возвращает текст комментария.
METHOD GetTime
Возвращает отметку времени создания комментария в формате текущего часового пояса.
METHOD GetTimeUTC
Возвращает метку времени создания комментария в формате UTC.
METHOD GetUserId
Возвращает идентификатор пользователя автора комментария.
METHOD IsSolved
Проверяет, решен комментарий или нет.
METHOD RemoveReplies
Удаляет указанные ответы на комментарии.
METHOD SetAutorName
Устанавливает имя автора комментария.
METHOD SetSolved
Отмечает комментарий как решенный.
METHOD SetText
Отмечает комментарий как решенный.
METHOD SetTime
Устанавливает метку времени создания комментария в формате текущего часового пояса.
METHOD SetTimeUTC
Устанавливает метку времени создания комментария в формате UTC.
METHOD SetUserId
Устанавливает идентификатор пользователя для автора комментария.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("This is just a sample text");
Api.AddComment(oParagraph, "comment", "John Smith");
var aComments = oDocument.GetAllComments();
aComments[0].SetTimeUTC("1672247153658");
aComments[0].SetUserId("uid-1");
aComments[0].AddReply("reply1", "Mark Potato", "uid-2", 0);
var sType = aComments[0].GetClassType();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Class type: " + sType);
oDocument.Push(oParagraph);
var sTimeUTC = aComments[0].GetTimeUTC();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("The timestamp of comment creation: " + sTimeUTC);
oDocument.Push(oParagraph);
var sAuthor = aComments[0].GetAuthorName();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Comment author name: " + sAuthor);
oDocument.Push(oParagraph);
var sQuoteText = aComments[0].GetQuoteText();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Comment quote text: " + sQuoteText);
oDocument.Push(oParagraph);
var sText = aComments[0].GetText();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Comment text: " + sText);
oDocument.Push(oParagraph);
var sUserId = aComments[0].GetUserId();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Comment user ID: " + sUserId);
oDocument.Push(oParagraph);
aComments[0].SetSolved(true);
var bSolved = aComments[0].IsSolved();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("The comment is solved: " + bSolved);
oDocument.Push(oParagraph);
var nReplies = aComments[0].GetRepliesCount();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Number of comment replies: " + nReplies);
oDocument.Push(oParagraph);
var oCommentReply = aComments[0].GetReply(0);
oParagraph = Api.CreateParagraph();
oParagraph.AddText("First comment reply: " + oCommentReply.GetText());
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiComment.docx");
builder.CloseFile();CLASS ApiCommentReply
new ApiCommentReply()
Класс для работы с ответами на комментариями.
Методы
METHOD GetAutorName
Возвращает имя автора ответа на комментарий.
METHOD GetClassType
Возвращает тип класса ApiCommentReply.
METHOD GetText
Возвращает текст ответа на комментарий.
METHOD GetUserId
Возвращает идентификатор пользователя автора ответа на комментарий.
METHOD SetAutorName
Устанавливает имя автора ответа на комментарий.
METHOD SetText
Устанавливает текст ответа на комментарий.
METHOD SetUserId
Устанавливает идентификатор пользователя для автора ответа на комментарий.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("This is just a sample text");
Api.AddComment(oParagraph, "comment", "John Smith");
var aComments = oDocument.GetAllComments();
aComments[0].AddReply("reply1", "Mark Potato", "uid-2", 0);
var oCommentReply = aComments[0].GetReply(0);
oCommentReply.SetAuthorName("Hamish Mitchell");
oCommentReply.SetText("new reply");
oCommentReply.SetUserId("uid-1");
var sType = oCommentReply.GetClassType();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Class type: " + sType);
var sAuthor = oCommentReply.GetAuthorName();
oDocument.Push(oParagraph);
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Comment reply author: " + sAuthor);
oDocument.Push(oParagraph);
var sText = oCommentReply.GetText();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Comment reply text: " + sText);
oDocument.Push(oParagraph);
var sUserId = oCommentReply.GetUserId();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Comment reply user ID: " + sUserId);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiCommentReply.docx");
builder.CloseFile();CLASS ApiComplexForm
new ApiComplexForm()
Класс, представляющий собой комплексную форму.
Методы
METHOD Clear
Унаследован от: ApiFormBase.Clear
Очищает текущую форму.
METHOD Copy
Унаследованный от: ApiFormBase.Copy.
Копирует текущую форму (копирует вместе с формой, если она существует).
METHOD GetClassType
Унаследованный от: ApiFormBase#GetClassType.
Возвращает тип класса ApiFormBase.
METHOD GetFormKey
Унаследованный от: ApiFormBase#GetFormKey.
Возвращает текущий ключ формы.
METHOD GetFormType
Унаследованный от: ApiFormBase#GetFormType.
Возвращает тип текущей формы.
METHOD GetText
Унаследованный от: ApiFormBase#GetText.
Возвращает текст из текущей формы.
METHOD GetTextPr
Унаследованный от: ApiFormBase#GetTextPr.
Возвращает свойства текста из текущей формы.
METHOD GetTipText
Унаследовано от: ApiFormBase#GetTipText.
Возвращает текст подсказки текущей формы.
METHOD GetWrapperShape
Унаследованный от: ApiFormBase.GetWrapperShape.
Возвращает форму, в которую помещается форма для управления положением и размером рамки формы фиксированного размера.
METHOD IsFixed
Унаследованный от: ApiFormBase.IsFixed.
Проверяет, имеет ли текущая форма фиксированный размер.
METHOD IsRequired
Унаследованный от: ApiFormBase#IsRequired.
Проверяет, требуется ли текущая форма.
METHOD SetBackgroundColor
Унаследованный от: ApiFormBase#SetBackgroundColor.
Устанавливает цвет фона для текущей формы.
METHOD SetBorderColor
Унаследованный от: ApiFormBase#SetBorderColor.
Устанавливает цвет границы для текущей формы.
METHOD SetFormKey
Унаследованный от: ApiFormBase#SetFormKey.
Устанавливает ключ для текущей формы.
METHOD SetPlaceholderText
Унаследованный от: ApiFormBase#SetPlaceholderText.
Устанавливает текст-заполнитель в текущую форму.
METHOD SetRequired
Унаследованный от: ApiFormBase#SetRequired.
Указывает, требуется ли текущая форма.
METHOD SetTextPr
Унаследованный от: ApiFormBase#SetTextPr.
Устанавливает свойства текста для текущей формы.
METHOD SetTipText
Унаследованный от: ApiFormBase#SetTipText.
Устанавливает текст подсказки для текущей формы.
METHOD ToFixed
Унаследованный от: ApiFormBase#ToFixed.
Преобразует текущую форму в форму фиксированного размера.
METHOD ToInline
Унаследованный от: ApiFormBase#ToInline.
Преобразует текущую форму во встроенную форму.
CLASS ApiDocument
new ApiDocument()
Класс, представляющий собой документ.
Методы
METHOD AcceptAllRevisionChanges
Принимает все изменения, сделанные в режиме просмотра.
METHOD AddComment
Добавляет комментарий к документу.
METHOD AddElement
Добавляет абзац, таблицу или элемент управления содержимым blockLvl, используя его позицию в содержимом документа.
METHOD AddEndnote
Добавляет концевую сноску для выделенного текста (или текущей позиции, если выделения не существует).
METHOD AddFootnote
Добавляет сноску для выделенного текста (или текущей позиции, если выделение не существует).
METHOD AddTableOfContents
Добавляет оглавление в текущий документ.
METHOD AddTableOfFigures
Добавляет таблицу рисунков в текущий документ.
METHOD ClearAllFields
Очищает все формы в документе.
METHOD CreateNewHistoryPoint
Создает новую точку истории.
METHOD CreateNumbering
Создает абстрактную многоуровневую нумерацию с указанным типом.
METHOD CreateSection
Создает новый раздел документа, который заканчивается на указанном абзаце.
METHOD CreateStyle
Создает новый стиль с указанным типом и именем.
METHOD DeleteBookmark
Удаляет закладку из документа, если она существует.
METHOD GetAllBookmarksNames
Возвращает массив с именами всех закладок в текущем документе.
METHOD GetAllCaptionParagraphs
Возвращает все абзацы заголовков указанного типа из текущего документа.
METHOD GetAllCharts
Унаследованный от: ApiDocumentContent#GetAllCharts.
Возвращает коллекцию объектов диаграмм из содержимого документа.
METHOD GetAllComments
Возвращает все комментарии из текущего документа.
METHOD GetAllContentControls
Возвращает список всех элементов управления содержимым из документа.
METHOD GetAllDrawingObjects
Унаследованный от: ApiDocumentContent#GetAllDrawingObjects.
Возвращает коллекцию объектов рисования из содержимого документа.
METHOD GetAllForms
Возвращает все существующие формы в документе.
METHOD GetAllHeadingParagraphs
Возвращает все заголовки абзацев текущего документа.
METHOD GetAllImages
Унаследованный от: ApiDocumentContent#GetAllImages.
Возвращает коллекцию объектов изображения из содержимого документа.
METHOD GetAllNumberedParagraphs
Возвращает все пронумерованные абзацы из текущего документа.
METHOD GetAllOleObjects
Унаследованный от: ApiDocumentContent#GetAllOleObjects.
Возвращает коллекцию OLE-объектов из содержимого документа.
METHOD GetAllParagraphs
Унаследовано от: ApiDocumentContent#GetAllParagraphs.
Возвращает массив всех абзацев из текущего содержимого документа.
METHOD GetAllShapes
Унаследованный от: ApiDocumentContent#GetAllShapes.
Возвращает коллекцию объектов формы из содержимого документа.
METHOD GetAllStyles
Возвращает все стили текущего документа.
METHOD GetAllTables
Унаследовано от: ApiDocumentContent#GetAllTables.
Возвращает массив всех таблиц из текущего содержимого документа.
METHOD GetAllTablesOnPage
Возвращает набор таблиц на данной абсолютной странице.
METHOD GetBookmarkRange
Возвращает диапазон закладок.
METHOD GetClassType
Возвращает тип класса ApiDocument.
METHOD GetCommentById
Возвращает комментарий из текущего документа по его идентификатору.
METHOD GetCommentsReport
Возвращает отчет обо всех комментариях, добавленных к документу.
METHOD GetContent
Унаследованный от: ApiDocumentContent#GetContent.
Возвращает массив элементов документа из текущего объекта ApiDocumentContent.
METHOD GetContentControlsByTag
Возвращает список всех элементов управления содержимым в документе с указанным именем тега.
METHOD GetDefaultParaPr
Возвращает набор свойств абзаца по умолчанию в текущем документе.
METHOD GetDefaultStyle
Возвращает параметры стиля по умолчанию для заданного элемента документа.
METHOD GetDefaultTextPr
Возвращает набор свойств по умолчанию для текста, запускаемого в текущем документе.
METHOD GetElement
Унаследованный от: ApiDocumentContent.GetElement.
Возвращает элемент по его позиции в документе.
METHOD GetElementsCount
Унаследованный от: ApiDocumentContent.GetElementsCount.
Возвращает количество элементов в текущем документе.
METHOD GetEndNotesFirstParagraphs
Возвращает первые абзацы всех концевых сносок в текущем документе.
METHOD GetFinalSection
Возвращает заключительный раздел документа.
METHOD GetFootnotesFirstParagraphs
Возвращает первые абзацы всех сносок в текущем документе.
METHOD GetFormsByTag
Возвращает список всех форм в документе с указанным именем тега.
METHOD GetPageCount
Возвращает количество страниц в документе
METHOD GetRange
Возвращает объект Range, представляющий часть документа, содержащуюся в указанном документе.
METHOD GetRangeBySelect
Возвращает объект диапазона по текущему подбору объектов.
METHOD GetReviewReport
Возвращает отчет обо всех изменениях, внесенных в документ в режиме просмотра.
METHOD GetSections
Возвращает коллекцию объектов раздела в документе.
METHOD GetSelectedDrawings
Возвращает все выбранные рисунки в текущем документе.
METHOD GetStatistics
Возвращает статистику документа в виде объекта с определёнными параметрами.
METHOD GetStyle
Возвращает стиль по его имени.
METHOD GetTagsOfAllContentControls
Возвращает список всех тегов, которые используются для всех элементов управления содержимым в документе.
METHOD GetTagsOfAllForms
Возвращает список всех тегов, используемых для всех форм в документе.
METHOD InsertContent
Вставляет массив элементов в текущую позицию документа.
METHOD InsertWatermark
Вставляет водяной знак на каждую страницу документа.
METHOD IsTrackRevisions
Проверяет, включен ли режим отслеживания изменений.
METHOD Last
Возвращает последний элемент документа.
METHOD Push
Унаследованный от: ApiDocumentContent.Push.
Пушит изменения в абзаце или таблице, что фактически добавляет их в документ.
METHOD RejectAllRevisionChanges
Отклоняет все изменения, сделанные в режиме просмотра.
METHOD RemoveAllElements
Унаследованный от: ApiDocumentContent.RemoveAllElements.
Удаляет все элементы из текущего документа или из элемента текущего документа.
METHOD RemoveElement
Унаследованный от: ApiDocumentContent.RemoveElement.
Удаляет элемент, используя заданную позицию.
METHOD RemoveSelection
Удаляет текущий выбор.
METHOD ReplaceCurrentImage
Заменяет текущее изображение на указанное изображение.
METHOD ReplaceDrawing
Заменяет старый рисунок новым.
METHOD Search
Ищет область объекта документа.
METHOD SearchAndReplace
Находит и заменяет текст.
METHOD SetControlsHighlight
Устанавливает выделение на элементы управления содержимым из текущего документа.
METHOD SetEvenAndOddHdrFtr
Указывает, будут ли разделы в этом документе иметь разные верхние и нижние колонтитулы для четных и нечетных страниц (один верхний/нижний колонтитул для нечетных страниц и другой верхний/нижний колонтитул для четных страниц).
METHOD SetFormsHighlight
Задает подсветку для форм в документе.
METHOD SetTrackRevisions
Задает режим отслеживания изменений.
METHOD ToHtml
Конвертирует документ в HTML.
METHOD ToJSON
Преобразует объект ApiDocument в объект JSON.
METHOD ToMarkdown
Преобразует документ в Markdown.
METHOD UpdateAllTOC
Обновляет все оглавления в текущем документе.
METHOD UpdateAllTOF
Обновляет все таблицы с рисунками/со значениями в текущем документе.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oNoSpacingStyle = oDocument.GetStyle("No Spacing");
var oSection = oDocument.GetFinalSection();
var oHeader = oSection.GetHeader("default", true);
var oParagraph = oHeader.GetElement(0);
oParagraph.AddText("This is the text in the default header");
var oTextPr = oDocument.GetDefaultTextPr();
oTextPr.SetFontSize(22);
oTextPr.SetLanguage("en-US");
oTextPr.SetFontFamily("Calibri");
var oParaPr = oDocument.GetDefaultParaPr();
oParaPr.SetSpacingLine(276, "auto");
oParaPr.SetSpacingAfter(200);
var oNormalStyle = oDocument.GetDefaultStyle("paragraph");
oParaPr = oNormalStyle.GetParaPr();
oParaPr.SetSpacingLine(240, "auto");
oParaPr.SetJc("both");
oTextPr = oNormalStyle.GetTextPr();
oTextPr.SetColor(0x26, 0x26, 0x26, false);
var oHeading1Style = oDocument.CreateStyle("Heading 1", "paragraph");
oParaPr = oHeading1Style.GetParaPr();
oParaPr.SetKeepNext(true);
oParaPr.SetKeepLines(true);
oParaPr.SetSpacingAfter(240);
oTextPr = oHeading1Style.GetTextPr();
oTextPr.SetColor(0xff, 0x68, 0x00, false);
oTextPr.SetFontSize(40);
oTextPr.SetFontFamily("Calibri Light");
oParagraph = oDocument.GetElement(0);
oParagraph.SetStyle(oHeading1Style);
oParagraph.AddText("This is a heading");
oParagraph = Api.CreateParagraph();
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.AddText("Number of paragraph elements after we added a text run: ");
oRun.AddTabStop();
oRun.AddText("" + oParagraph.GetElementsCount());
oDocument.Push(oParagraph);
var oNumbering = oDocument.CreateNumbering("bullet");
for (let nLvl = 0; nLvl < 8; ++nLvl) {
var oNumLvl = oNumbering.GetLevel(nLvl);
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Default bullet lvl " + (nLvl + 1));
oParagraph.SetNumbering(oNumLvl);
oParagraph.SetContextualSpacing(true);
oDocument.Push(oParagraph);
}
builder.SaveFile("docx", "ApiDocument.docx");
builder.CloseFile();CLASS ApiDocumentContent
new ApiDocumentContent()
Класс, представляющий контейнер для абзацев и таблиц.
Методы
METHOD AddElement
Унаследованный от: ApiDocumentContent.AddElement.
Добавляет абзац, таблицу или элемент управления содержимым blockLvl, используя его положение в содержимом документа.
METHOD GetAllCharts
Возвращает коллекцию объектов диаграммы из содержимого документа.
METHOD GetAllDrawingObjects
Возвращает коллекцию объектов рисования из содержимого документа.
METHOD GetAllImages
Возвращает коллекцию объектов изображения из содержимого документа.
METHOD GetAllOleObjects
Возвращает коллекцию OLE-объектов из содержимого документа.
METHOD GetAllParagraphs
Возвращает массив всех абзацев из текущего содержимого документа.
METHOD GetAllShapes
Возвращает коллекцию объектов формы из содержимого документа.
METHOD GetAllTables
Возвращает массив всех таблиц из текущего содержимого документа.
METHOD GetClassType
Возвращает тип класса ApiDocumentContent.
METHOD GetContent
Возвращает массив элементов документа из текущего объекта ApiDocumentContent.
METHOD GetElement
Возвращает элемент по его позиции в документе.
METHOD GetElementsCount
Возвращает количество элементов в текущем документе.
METHOD GetRange
Возвращает объект Range, который представляет часть документа, находящийся в содержимом документа.
METHOD Push
Пушит изменения в абзац или таблицу, чтобы фактически добавить их в документ.
METHOD RemoveAllElements
Удаляет все элементы из текущего документа или из элемента текущего документа.
METHOD RemoveElement
Удаляет элемент по заданной позиции.
METHOD ToJSON
Преобразует объект ApiDocumentContent в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oFill = Api.CreateSolidFill(Api.CreateRGBColor(104, 155, 104));
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oDrawing = Api.CreateShape("rect", 3212465, 963295, oFill, oStroke);
oParagraph.AddDrawing(oDrawing);
var oDocContent = oDrawing.GetDocContent();
oDocContent.RemoveAllElements();
oParagraph = oDocContent.GetElement(0);
oParagraph.AddText("We removed all elements from the shape and added a new paragraph inside it.");
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Number of elements inside the shape: " + oDocContent.GetElementsCount());
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiDocumentContent.docx");
builder.CloseFile();CLASS ApiDrawing
new ApiDrawing()
Класс, представляющий графический объект.
Методы
METHOD AddBreak
Вставляет разрыв в указанное место в основном документе.
METHOD Copy
Копирует текущий графический объект.
METHOD Delete
Удаляет текущий графический объект.
METHOD Fill
Задает свойства форматирования заливки для текущего графического объекта.
METHOD GetClassType
Возвращает тип класса ApiDrawing.
METHOD GetHeight
Возвращает высоту текущего рисунка.
METHOD GetLockValue
Возвращает значение блокировки для указанного типа блокировки текущего чертежа..
METHOD GetNextDrawing
Возвращает следующий встроенный объект рисования, если он существует.
METHOD GetParentContentControl
Возвращает родительский элемент управления содержимым, содержащий графический объект.
METHOD GetParentParagraph
Возвращает родительский абзац, содержащий графический объект.
METHOD GetParentTable
Возвращает таблицу, содержащую текущий элемент управления содержимым.
METHOD GetParentTableCell
Возвращает ячейку родительской таблицы, содержащую графический объект.
METHOD GetPrevDrawing
Возвращает предыдущий встроенный объект рисования, если он существует.
METHOD GetWidth
Возвращает ширину текущего рисунка.
METHOD InsertInContentControl
Обертывает графический объект элементом управления с расширенным текстовым содержимым.
METHOD InsertParagraph
Вставляет абзац в указанную позицию.
METHOD ScaleHeight
Масштабирует высоту фигуры с помощью заданного коэффициента.
METHOD ScaleWidth
Масштабирует ширину фигуры с помощью указанного коэффициента.
METHOD Select
Выбирает текущий графический объект.
METHOD SetDistances
Определяет минимальное расстояние, которое будет поддерживаться между краями текущего объекта рисования и любым последующим текстом.
METHOD SetDrawingPrFromDrawing
Устанавливает свойства из одного рисунка в текущий рисунок.
METHOD SetHorAlign
Указывает, как плавающий объект будет выровнен по горизонтали.
METHOD SetHorFlip
Переворачивает текущий рисунок по горизонтали.
METHOD SetHorPosition
Устанавливает абсолютное измерение для горизонтального позиционирования плавающего объекта.
METHOD SetLockValue
Устанавливает значение блокировки на указанный тип блокировки текущего рисунка.
METHOD SetOutLine
Задает свойства контура для указанного графического объекта.
METHOD SetSize
Задает размер ограничивающей рамки (изображение, фигура, диаграмма).
METHOD SetVerAlign
Указывает, как плавающий объект будет выровнен по вертикали.
METHOD SetVerPosition
Задает абсолютное измерение для вертикального позиционирования плавающего объекта.
METHOD SetVertFlip
Переворачивает текущий рисунок вертикально.
METHOD SetWrappingStyle
Задает тип обтекания текущего объекта (изображение, фигура, диаграмма).
METHOD ToJSON
Преобразует объект ApiDrawing в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("This is a paragraph with a shape. ");
oParagraph.AddText("The text wraps the rectangular box that bounds the object. ");
oParagraph.AddText("The distance between the shape and the text is half an inch (457200 English measure units).");
var oGs1 = Api.CreateGradientStop(Api.CreateRGBColor(255, 224, 204), 0);
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(155, 64, 1), 100000);
var oFill = Api.CreateRadialGradientFill([oGs1, oGs2]);
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oDrawing = Api.CreateShape("rect", 1908000, 1404000, oFill, oStroke);
oDrawing.SetDistances(457200, 457200, 457200, 0);
oDrawing.SetWrappingStyle("square");
oDrawing.SetHorAlign("page", "center");
oParagraph.AddDrawing(oDrawing);
oParagraph = Api.CreateParagraph();
oParagraph.AddText("This is another paragraph.");
oDocument.Push(oParagraph);
oParagraph = Api.CreateParagraph();
oParagraph.AddText("The shape is aligned at the center of the page horizontally.");
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiDrawing.docx");
builder.CloseFile();CLASS ApiFill
new ApiFill()
Класс, представляющий базовый класс для заливки.
Методы
METHOD GetClassType
Возвращает тип класса ApiFill.
METHOD ToJSON
Преобразует объект ApiFill в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oGs1 = Api.CreateGradientStop(Api.CreateRGBColor(255, 224, 204), 0);
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(155, 64, 1), 100000);
var oFill = Api.CreateRadialGradientFill([oGs1, oGs2]);
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oDrawing = Api.CreateShape("rect", 1908000, 1404000, oFill, oStroke);
oDrawing.SetDistances(914400, 0, 914400, 0);
oDrawing.SetWrappingStyle("square");
oParagraph.AddDrawing(oDrawing);
var sClassType = oFill.GetClassType();
oParagraph.AddText("Class Type = " + sClassType);
builder.SaveFile("docx", "ApiFill.docx");
builder.CloseFile();CLASS ApiFormBase
new ApiFormBase()
Класс, представляющий основу формы документа.
Характеристики
| Название | Тип | Описание |
| key | string | Ключ формы. |
| tip | string | Подсказка формы (tip). |
| required | boolean | Указывает, является ли форма обязательной или нет. |
| placeholder | string | Текст плейсхолдера. |
Методы
METHOD Clear
Очищает текущую форму.
METHOD Copy
Копирует текущую форму (копирует вместе с формой, если она существует).
METHOD GetClassType
Возвращает тип класса ApiFormBase.
METHOD GetFormKey
Возвращает текущий ключ формы.
METHOD GetFormType
Возвращает тип текущей формы.
METHOD GetText
Возвращает текст из текущей формы.
METHOD GetTextPr
Возвращает свойства текста из текущей формы.
METHOD GetTipText
Возвращает текст подсказки текущей формы.
METHOD GetWrapperShape
Возвращает форму, в которую помещается форма для управления положением и размером рамки формы с фиксированным размером.
METHOD IsFixed
Проверяет, имеет ли текущая форма фиксированный размер.
METHOD IsRequired
Проверяет, требуется ли текущая
METHOD SetBackgroundColor
Задает цвет фона для текущей формы.
METHOD SetBorderColor
Задает цвет границы текущей формы.
METHOD SetFormKey
Устанавливает ключ в текущую форму.
METHOD SetPlaceholderText
Устанавливает плейсхолдер в текущую форму.
METHOD SetRequired
Указывает, требуется ли текущая форма.
METHOD SetTextPr
Устанавливает свойства текста для текущей формы.
METHOD SetTipText
Устанавливает текст подсказки в текущую форму.
METHOD ToFixed
Конвертирует текущую форму в форму фиксированного размера.
METHOD ToInline
Конвертирует текущую форму во встроенную форму.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTextForm = Api.CreateTextForm({
"key": "Personal information",
"tip": "Enter your first name",
"required": true,
"placeholder": "First name",
"comb": true,
"maxCharacters": 10,
"cellWidth": 3,
"multiLine": false,
"autoFit": false
});
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oTextForm);
oTextForm.SetBorderColor(255, 0, 0);
oTextForm.ToFixed(10 * 240, 2 * 240);
oTextForm.SetText("John Smith");
var oTextPr = oDocument.GetDefaultTextPr();
oTextPr.SetFontSize(30);
oTextPr.SetBold(true);
oTextForm.SetTextPr(oTextPr);
var oFormTextPr = oTextForm.GetTextPr();
oFormTextPr.SetItalic(true);
var oShape = oTextForm.GetWrapperShape();
var oStroke = Api.CreateStroke(36000, Api.CreateSolidFill(Api.CreateRGBColor(255, 0, 0)));
oShape.SetOutLine(oStroke);
var oCopyForm = oTextForm.Copy();
oParagraph = Api.CreateParagraph();
oParagraph.AddElement(oCopyForm);
oDocument.Push(oParagraph);
oCopyForm.ToInline();
var sText = oTextForm.GetText();
var sClassType = oTextForm.GetClassType();
var sFormType = oTextForm.GetFormType();
var bFixed = oTextForm.IsFixed();
var bFixedCopy = oCopyForm.IsFixed();
var bRequired = oTextForm.IsRequired();
var sKey = oTextForm.GetFormKey();
var sTipText = oTextForm.GetTipText();
oCopyForm.SetText("John Smith");
oCopyForm.Clear();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Class type: " + sClassType);
oParagraph.AddLineBreak();
oParagraph.AddText("Form type: " + sFormType);
oParagraph.AddLineBreak();
oParagraph.AddText("Form text: " + sText);
oParagraph.AddLineBreak();
oParagraph.AddText("The first form from this document has a fixed size: " + bFixed);
oParagraph.AddLineBreak();
oParagraph.AddText("The second form from this document has a fixed size: " + bFixedCopy);
oParagraph.AddLineBreak();
oParagraph.AddText("The first form from this document is required: " + bRequired);
oParagraph.AddLineBreak();
oParagraph.AddText("Form key: " + sKey);
oParagraph.AddLineBreak();
oParagraph.AddText("Form tip text: " + sTipText);
oParagraph.AddLineBreak();
oParagraph.AddText("The second form from this document was cleared.");
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiFormBase.docx");
builder.CloseFile();CLASS ApiGradientStop
new ApiGradientStop()
Класс, представляющий градиентную остановку.
Методы
METHOD GetClassType
Возвращает тип класса ApiGradientStop.
METHOD ToJSON
Преобразует объект ApiGradientStop в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oGs1 = Api.CreateGradientStop(Api.CreateRGBColor(255, 224, 204), 0);
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(155, 64, 1), 100000);
var oFill = Api.CreateRadialGradientFill([oGs1, oGs2]);
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oDrawing = Api.CreateShape("rect", 1908000, 1404000, oFill, oStroke);
oDrawing.SetDistances(914400, 0, 914400, 0);
oDrawing.SetWrappingStyle("square");
oParagraph.AddDrawing(oDrawing);
var sClassType = oGs1.GetClassType();
oParagraph.AddText("Class Type = " + sClassType);
builder.SaveFile("docx", "ApiGradientStop.docx");
builder.CloseFile();CLASS ApiHyperlink
new ApiHyperlink()
Класс, представляющий гиперссылку Paragraph.
Методы
METHOD GetClassType
Возвращает тип класса ApiHyperlink.
METHOD GetDisplayedText
Возвращает отображаемый текст гиперссылки.
METHOD GetElement
Возвращает элемент гиперссылки с заданной позицией.
METHOD GetElementsCount
Возвращает количество элементов в текущей гиперссылке.
METHOD GetLinkedText
Возвращает адрес гиперссылки.
METHOD GetRange
Возвращает объект Range, представляющий часть документа, содержащуюся в указанной гиперссылке.
METHOD GetScreenTipText
Возвращает текст всплывающей подсказки гиперссылки.
METHOD SetDefaultStyle
Задает стиль гиперссылки по умолчанию.
METHOD SetDisplayedText
Задает текст для отображения гиперссылки.
METHOD SetLink
Устанавливает адрес гиперссылки.
METHOD SetScreenTipText
Устанавливает текст всплывающей подсказки гиперссылки.
METHOD ToJSON
Конвертирует объект ApiHyperlink в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oRun = Api.CreateRun();
oRun.AddText("Api R7");
oParagraph.AddElement(oRun);
var oHyperlink = oParagraph.AddHyperlink("https://support.r7-office.ru/");
oHyperlink.SetLink("https://support.r7-office.ru);
oHyperlink.SetScreenTipText("R7 for developers"); oHyperlink.SetDisplayedText("R7");
var oLinkedText = oHyperlink.GetLinkedText();
var oScreenTipText = oHyperlink.GetScreenTipText(); oParagraph = Api.CreateParagraph(); oParagraph.AddText("Linked text: " + oLinkedText); oParagraph.AddLineBreak(); oParagraph.AddText("Screen tip text: " + oScreenTipText); oDocument.Push(oParagraph);
var oRange = oHyperlink.GetRange(0, 9); oRange.SetBold(true); builder.SaveFile("docx", "ApiHyperlink .docx"); builder.CloseFile(); CLASS ApiImage
new ApiImage()
Класс, представляющий изображение.
Методы
METHOD GetClassType
Возвращает тип класса ApiImage.
METHOD GetNextImage
Возвращает последующее встроенное изображение, если оно существует.
METHOD GetPrevImage
Возвращает предыдущее встроенное изображение, если оно существует.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oDrawing = Api.CreateImage("https://site.com/coordinate_aspects.png", 60 * 36000, 35 * 36000);
oParagraph.AddDrawing(oDrawing);
var sClassType = oDrawing.GetClassType();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Class Type = " + sClassType);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiImage.docx");
builder.CloseFile();CLASS ApiInlineLvlSdt
new ApiInlineLvlSdt()
Класс, представляющий контейнер для элементов абзаца.
Методы
METHOD AddComment
Добавляет комментарий к текущему встроенному элементу управления содержимым.
METHOD AddElement
Добавляет элемент во встроенный текстовый элемент управления содержимым.
METHOD AddText
Добавляет текст в текущий элемент управления содержимым.
METHOD Copy
Создает копию встроенного элемента управления содержимым.
METHOD Delete
Удаляет элемент управления содержимым и его содержимое.
METHOD GetAlias
Возвращает атрибут псевдонима для текущего контейнера.
METHOD GetClassType
Возвращает тип класса ApiInlineLvlSdt.
METHOD GetElement
Возвращает элемент абзаца, используя заданную позицию.
METHOD GetElementsCount
Возвращает количество элементов в текущем элементе управления встроенным текстовым содержимым.
METHOD GetLabel
Возвращает атрибут label для текущего контейнера.
METHOD GetLock
Возвращает тип блокировки текущего контейнера.
METHOD GetParentContentControl
Возвращает элемент управления содержимым, который содержит текущий элемент управления содержимым.
METHOD GetParentParagraph
Возвращает абзац, который содержит текущий элемент управления содержимым.
METHOD GetParentTable
Возвращает таблицу, содержащую текущий абзац.
METHOD GetParentTableCell
Возвращает ячейку в таблице, содержащую текущий элемент управления содержимым.
METHOD GetPlaceholderText
Возвращает плейсхолдер из текущего встроенного элемента управления содержимым.
METHOD GetRange
Возвращает объект Range, представляющий часть документа, содержащуюся в указанном элементе управления содержимым.
METHOD GetTag
Возвращает атрибут тега для текущего контейнера.
METHOD IsForm
Проверяет, является ли элемент управления содержимым формой.
METHOD Push
Добавляет элемент в конец встроенного текстового элемента управления содержимым.
METHOD RemoveAllElements
Удаляет все элементы из текущего элемента управления встроенным текстовым содержимым.
METHOD RemoveElement
Удаляет элемент, используя позицию, указанную в текущем элементе управления встроенным текстовым содержимым.
METHOD SetAlias
Устанавливает атрибут псевдонима для текущего контейнера.
METHOD SetLabel
Добавляет строковый лебл к текущему элементу управления текстовым содержимым.
METHOD SetLock
Устанавливает блокировку для текущего встроенного текстового элемента управления содержимым.
METHOD SetPlaceholderText
Задает плейсхолдер для текущего встроенного элемента управления содержимым. Невозможно установить флажок или переключатель
METHOD SetTag
Добавляет строковый тег к текущему элементу управления встроенным текстовым содержимым.
METHOD SetTextPr
Применяет настройки текста к содержимому элемента управления содержимым.
METHOD ToJSON
Преобразует объект ApiInlineLvlSdt в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oInlineLvlSdt = Api.CreateInlineLvlSdt();
var oRun = Api.CreateRun();
oRun.AddText("This is an inline text content control.");
oInlineLvlSdt.AddElement(oRun, 0);
var changeRun = oInlineLvlSdt.GetElement(0);
changeRun.SetBold(true);
oParagraph.AddInlineLvlSdt(oInlineLvlSdt);
oInlineLvlSdt.SetAlias("№1");
var oAlias = oInlineLvlSdt.GetAlias();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Alias: " + oAlias);
oDocument.Push(oParagraph);
oInlineLvlSdt.SetLabel("2147483647");
var oLabel = oInlineLvlSdt.GetLabel();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Label: " + oLabel);
oDocument.Push(oParagraph);
oInlineLvlSdt.SetTag("This is a tag");
var oTag = oInlineLvlSdt.GetTag();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Tag: " + oTag);
oDocument.Push(oParagraph);
oInlineLvlSdt.SetLock("contentLocked");
var oLock = oInlineLvlSdt.GetLock();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Lock type: " + oLock);
oDocument.Push(oParagraph);
var sClassType = oInlineLvlSdt.GetClassType();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Class Type = " + sClassType);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiInlineLvlSdt.docx");
builder.CloseFile();CLASS ApiNumbering
new ApiNumbering()
Класс, представляющий свойства нумерации.
Методы
METHOD GetClassType
Возвращает тип класса ApiNumbering.
METHOD GetLevel
Возвращает заданный уровень текущей нумерации.
METHOD ToJSON
Преобразует объект ApiNumbering в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oNumbering = oDocument.CreateNumbering("bullet");
for (let nLvl = 0; nLvl < 8; ++nLvl) {
var oNumLvl = oNumbering.GetLevel(nLvl);
var oParagraph = Api.CreateParagraph();
oParagraph.AddText("Default bullet lvl " + (nLvl + 1));
oParagraph.SetNumbering(oNumLvl);
oParagraph.SetContextualSpacing(true);
oDocument.Push(oParagraph);
}
builder.SaveFile("docx", "ApiNumbering.docx");
builder.CloseFile();CLASS ApiNumberingLevel
new ApiNumberingLevel()
Класс, представляющий ссылку на определенный уровень нумерации.
Методы
METHOD GetClassType
Возвращает тип класса ApiNumberingLevel.
METHOD GetLevelIndex
Возвращает индекс уровня.
METHOD GetNumbering
Возвращает определение нумерации.
METHOD GetParaPr
Возвращает свойства абзаца, которые применяются к любому пронумерованному абзацу, ссылающемуся на данное определение нумерации и уровень нумерации.
METHOD GetTextPr
Указывает свойства текста, которые будут применяться к тексту на текущем уровне нумерации, а не к тексту в последующем абзаце.
METHOD SetCustomType
Устанавливает собственный настраиваемый тип нумерации.
METHOD SetRestart
Определяет индекс на основе единицы, который определяет, когда уровень нумерации должен возобновить свое начальное значение.
METHOD SetStart
Задает начальное значение для нумерации, используемой родительским уровнем нумерации в заданном определении уровня нумерации.
METHOD SetSuff
Определяет содержимое, которое будет добавлено между текстом данного уровня нумерации и текстом каждого нумерованного абзаца, который ссылается на этот уровень нумерации.
METHOD SetTemplateType
Задает один из существующих предопределенных шаблонов нумерации.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oNumbering = oDocument.CreateNumbering("numbered");
for (let nLvl = 0; nLvl < 8; ++nLvl) {
var oNumLvl = oNumbering.GetLevel(nLvl);
var sFormatString = "";
for (let nTempLvl = 1; nTempLvl <= (nLvl + 1); ++nTempLvl) sFormatString += "%" + nTempLvl + ".";
oNumLvl.SetCustomType("lowerRoman", sFormatString, "left");
oNumLvl.SetStart(nLvl + 1);
oNumLvl.SetSuff("space");
var oParagraph = Api.CreateParagraph();
oParagraph.AddText("Custom numbered lvl " + (nLvl + 1));
oParagraph.SetNumbering(oNumLvl);
oParagraph.SetContextualSpacing(true);
oDocument.Push(oParagraph);
}
builder.SaveFile("docx", "ApiNumberingLevel.docx");
builder.CloseFile();CLASS ApiOleObject
new ApiOleObject()
Класс, представляющий Ole-объект.
Методы
METHOD GetApplicationId
Возвращает идентификатор приложения из текущего объекта OLE.
METHOD GetClassType
Возвращает тип класса ApiOleObject.
METHOD GetData
Возвращает строковые данные из текущего объекта OLE.
METHOD SetApplicationId
Задает идентификатор приложения для текущего объекта OLE.
METHOD SetData
Устанавливает данные в текущий объект OLE.
CLASS ApiParagraph
new ApiParagraph()
Класс, представляющий параграф.
Методы
METHOD AddBookmarkCrossRef
Добавляет перекрестную ссылку-закладку к текущему абзацу.
METHOD AddCaption
Добавляет абзац заголовка после (или до) текущего абзаца.
METHOD AddCaptionCrossRef
Добавляет перекрестную ссылку подписи к текущему абзацу.
METHOD AddColumnBreak
Добавляет разрыв колонки к текущей позиции и начинает следующий элемент с новой колонки.
METHOD AddComment
Добавляет комментарий к абзацу.
METHOD AddDrawing
Добавляет объект рисования (изображение, фигуру или диаграмму) к текущему абзацу.
METHOD AddElement
Добавляет элемент в текущий абзац.
METHOD AddEndnoteCrossRef
Добавляет перекрестную ссылку к концевой сноске текущего абзаца.
METHOD AddFootnoteCrossRef
Добавляет перекрестную ссылку в сноске к текущему пункту.
METHOD AddHeadingCrossRef
Добавляет перекрестную ссылку на заголовок текущего абзаца.
METHOD AddHyperlink
Добавляет гиперссылку в абзац.
METHOD AddInlineLvlSdt
Добавляет встроенный контейнер.
METHOD AddLineBreak
Добавляет разрыв строки к текущей позиции и начинает следующий элемент с новой строки.
METHOD AddNumberedCrossRef
Добавляет пронумерованную перекрестную ссылку к текущему абзацу.
METHOD AddPageBreak
Добавляет разрыв страницы и запускает следующий элемент со следующей страницы.
METHOD AddPageNumber
Вставляет в абзац номер текущей страницы документа.
METHOD AddPagesCount
Вставляет в параграф количество страниц текущего документа.
METHOD AddTabStop
Добавляет ограничитель табуляции к текущему абзацу.
METHOD AddText
Добавляет текст в текущий абзац.
METHOD Copy
Создает копию абзаца. Игнорирует комментарии, ссылки на сноски, сложные поля.
METHOD Delete
Удаляет текущий абзац.
METHOD GetAllCharts
Возвращает коллекцию объектов диаграммы в параграфе.
METHOD GetAllContentControls
Возвращает коллекцию объектов управления содержимым в параграфе.
METHOD GetAllDrawingObjects
Возвращает коллекцию объектов рисования в абзаце.
METHOD GetAllImages
Возвращает коллекцию объектов изображений в параграфе.
METHOD GetAllOleObjects
Возвращает коллекцию объектов OLE в параграфе.
METHOD GetAllShapes
Возвращает коллекцию объектов фигуры в параграфе.
METHOD GetClassType
Возвращает тип класса ApiParagraph.
METHOD GetElement
Возвращает элемент абзаца, используя указанную позицию.
METHOD GetElementsCount
Возвращает количество элементов в текущем абзаце.
METHOD GetFontNames
Возвращает все названия шрифтов из всех элементов внутри текущего абзаца.
METHOD GetIndFirstLine
Унаследованный от: ApiParaPr#GetIndFirstLine.
Возвращает отступ первой строки абзаца.
METHOD GetIndLeft
Унаследовано от: ApiParaPr#GetIndLeft.
Возвращает отступ слева от абзаца.
METHOD GetIndRight
Унаследованный от: ApiParaPr#GetIndRight.
Возвращает отступ справа от абзаца.
METHOD GetJc
Унаследованный от: ApiParaPr#GetJc.
Возвращает обоснование содержимого абзаца.
METHOD GetLastRunWithText
Возвращает последний Run с текстом в текущем абзаце.
METHOD GetNext
Возвращает следующий абзац.
METHOD GetNumbering
Возвращает определение нумерации и уровень нумерации для нумерованного списка.
METHOD GetParagraphMarkTextPr
Возвращает текстовые свойства знака абзаца, который используется для обозначения конца абзаца.
METHOD GetParaPr
Возвращает свойства абзаца.
METHOD GetParentContentControl
Возвращает элемент управления содержимым, содержащий текущий абзац.
METHOD GetParentTable
Возвращает таблицу, содержащую текущий запуск.
METHOD GetParentTableCell
Возвращает ячейку таблицы, содержащую текущий абзац.
METHOD GetPosInParent
Возвращает позицию абзаца в его родительском элементе.
METHOD GetPrevious
Возвращает предыдущий абзац.
METHOD GetRange
Возвращает объект Range, который представляет часть документа, содержащуюся в указанном абзаце.
METHOD GetShd
Унаследованный от: ApiParaPr#GetShd.
Возвращает затенение, примененное к содержимому абзаца.
METHOD GetSpacingAfter
Унаследованный от: ApiParaPr#GetSpacingAfter.
Возвращает значение интервала после текущего абзаца.
METHOD GetSpacingBefore
Унаследованный от: ApiParaPr#GetSpacingBefore.
Возвращает значение интервала до для текущего абзаца.
METHOD GetSpacingLineRule
Унаследованный от: ApiParaPr#GetSpacingLineRule.
Возвращает правило межстрочного интервала в абзаце.
METHOD GetSpacingLineValue
Унаследованный от: ApiParaPr#GetSpacingLineValue.
Возвращает значение межстрочного интервала абзаца.
METHOD GetStyle
Унаследованный от: ApiParaPr#GetStyle.
Возвращает метод стиля абзаца.
METHOD GetText
Возвращает текст абзаца.
METHOD GetTextPr
Возвращает свойства текста параграфа.
METHOD InsertInContentControl
Обертывает объект абзаца элементом управления форматированным текстовым содержимым.
METHOD InsertParagraph
Вставляет абзац в указанную позицию.
METHOD Last
Возвращает последний элемент абзаца, который не пустой.
METHOD Push
Добавляет элемент к текущему абзацу.
METHOD RemoveAllElements
Удаляет все элементы из текущего параграфа.
METHOD RemoveElement
Удаляет элемент, используя указанную позицию.
METHOD ReplaceByElement
Заменяет текущий абзац новым элементом.
METHOD Search
Ищет область объекта абзаца.
METHOD Select
Выбирает текущий абзац.
METHOD SetBetweenBorder
Унаследованный от: ApiParaPr#SetBetweenBorder.
Указывает границу, которая будет отображаться между каждым абзацем в наборе абзацев с одинаковым набором настроек границы абзаца.
METHOD SetBold
Устанавливает свойство жирного шрифта для текстового символа.
METHOD SetBottomBorder
Унаследованный от: ApiParaPr#SetBottomBorder.
Указывает границу, которая будет отображаться под набором абзацев с одинаковыми настройками границы абзаца.
METHOD SetBullet
Унаследованный от: ApiParaPr#SetBullet.
Устанавливает маркер или нумерацию для текущего абзаца.
METHOD SetCaps
Указывает, что любые символы нижнего регистра в этом абзаце форматируются для отображения только как их эквиваленты символов заглавных букв.
METHOD SetColor
Устанавливает цвет текста для текущего абзаца в формате RGB.
METHOD SetContextualSpacing
Унаследованный от: ApiParaPr#SetContextualSpacing.
Указывает, что любое пространство до или после этого абзаца, заданное с помощью элемента интервала ApiParaPr#SetSpacingBefore или ApiParaPr#SetSpacingAfter, не должно применяться, если предыдущий и последующий абзацы имеют один и тот же стиль абзаца, что влияет на верхний и нижний интервалы соответственно.
METHOD SetDoubleStrikeout
Указывает, что содержимое этого абзаца отображается двумя горизонтальными линиями через каждый символ, отображаемый в строке.
METHOD SetFontFamily
Установка всех 4 шрифтов slot с указанным семейством шрифтов.
METHOD SetFontSize
Устанавливает размер шрифта в соответствии с символами текущего абзаца.
METHOD SetHighlight
Задает цвет выделения, который применяется в качестве фона к содержимому текущего абзаца.
METHOD SetIndFirstLine
Унаследованный от: ApiParaPr#SetIndFirstLine.
Устанавливает отступ первой строки абзаца.
METHOD SetIndLeft
Унаследованный от: ApiParaPr#SetIndLeft.
Устанавливает отступ слева от абзаца.
METHOD SetIndRight
Унаследованный от: ApiParaPr#SetIndRight.
Устанавливает отступ справа от абзаца.
METHOD SetItalic
Устанавливает свойство курсива для текстового символа.
METHOD SetJc
Унаследованный от: ApiParaPr#SetJc.
Устанавливает выравнивание содержимого абзаца.
METHOD SetKeepLines
Унаследованный от: ApiParaPr#SetKeepLines.
Указывает, что при рендеринге документа с использованием постраничного просмотра все строки текущего абзаца по возможности сохраняются на одной странице.
METHOD SetKeepNext
Унаследованный от: ApiParaPr#SetKeepNext.
Указывает, что при отображении документа с использованием просмотра с разбивкой по страницам содержимое текущего абзаца по крайней мере частично отображается на той же странице, что и следующий абзац, когда это возможно.
METHOD SetLeftBorder
Унаследованный от: ApiParaPr#SetLeftBorder.
Определяет границу, которая будет отображаться в левой части страницы вокруг указанного абзаца.
METHOD SetNumbering
Такой же как ApiParagraph#SetNumPr
Указывает, что текущий абзац ссылается на экземпляр определения нумерации в текущем документе.
METHOD SetNumPr
Указывает, что текущий абзац ссылается на экземпляр определения нумерации в текущем документе.
METHOD SetPageBreakBefore
Унаследованный от: ApiParaPr#SetPageBreakBefore.
Указывает, что при постраничном отображении документа содержимое текущего параграфа отображается в начале новой страницы документа.
METHOD SetPosition
Указывает величину, на которую текст увеличивается или уменьшается для данного абзаца по отношению к базовой линии по умолчанию окружающего не позиционированного текста.
METHOD SetRightBorder
Унаследованный от: ApiParaPr#SetRightBorder.
Задает границу, которая будет отображаться в правой части страницы вокруг указанного абзаца.
METHOD SetShd
Унаследовано от: ApiParaPr#SetShd Определяет затемнение, применяемый к содержимому текущего абзаца.
METHOD SetSmallCaps
Указывает, что все символы строчных букв в этом абзаце форматируются для отображения только как эквиваленты символов прописных букв, которые на два пункта меньше фактического размера шрифта, указанного для этого текста.
METHOD SetSpacing
Устанавливает интервал между текстом, измеряемый в двадцатых долях пункта.
METHOD SetSpacingAfter
Унаследованный от: ApiParaPr#SetSpacingAfter.
Устанавливает интервал после текущего абзаца. Если значение параметра isAfterAuto равно true, то любое значение nAfter игнорируется.
METHOD SetSpacingBefore
Унаследованный от: ApiParaPr#SetSpacingBefore.
Устанавливает интервал перед текущим абзацем.
METHOD SetSpacingLine
Унаследованный от: ApiParaPr#SetSpacingLine.
Устанавливает межстрочный интервал абзаца.
METHOD SetStrikeout
Указывает, что содержимое этого абзаца отображается одной горизонтальной линией, проходящей через центр строки.
METHOD SetStyle
Унаследованный от: ApiParaPr.SetStyle.
Базовый метод стиля абзаца.
METHOD SetTabs
Унаследованный от: ApiParaPr#SetTabs.
Задает последовательность пользовательских ограничителей табуляции, которые будут использоваться для любых символов табуляции в текущем абзаце.
METHOD SetTextPr
Задает свойства текста в абзаце.
METHOD SetTopBorder
Унаследованный от: ApiParaPr#SetTopBorder.
Определяет границу, которая будет отображаться над набором абзацев, имеющих одинаковые настройки границ абзацев.
METHOD SetUnderline
Указывает, что содержимое этого абзаца отображается вместе со строкой, появляющейся непосредственно под символом (меньше, чем все интервалы над и под символами в строке).
METHOD SetVertAlign
Определяет выравнивание, которое будет применяться к содержимому этого абзаца по отношению к внешнему виду текста абзаца по умолчанию.
METHOD SetWidowControl
Унаследованный от: ApiParaPr#SetWidowControl.
Указывает, будет ли одна строка текущего абзаца отображаться на отдельной странице от остального содержимого во время отображения путем перемещения строки на следующую страницу.
METHOD ToJSON
Преобразует объект ApiParagraph в объект JSON.
METHOD WrapInMailMergeField
Оборачивает содержимое абзаца в поле слияния почты.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("This is a paragraph with the text in it aligned by the left side. ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes. ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes.");
oParagraph.SetJc("left");
oParagraph = Api.CreateParagraph();
oParagraph.AddText("This is a paragraph with the text in it aligned by the right side. ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes. ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes.");
oParagraph.SetJc("right");
oDocument.Push(oParagraph);
oParagraph = Api.CreateParagraph();
oParagraph.AddText("This is a paragraph with the text in it aligned by the center. ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes. ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes.");
oParagraph.SetJc("center");
oDocument.Push(oParagraph);
oParagraph = Api.CreateParagraph();
oParagraph.AddText("This is a paragraph with the text in it aligned by both sides (justified). ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes. ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes.");
oParagraph.SetJc("both");
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiParagraph.docx");
builder.CloseFile();CLASS ApiParaPr
new ApiParaPr()
Класс, представляющий свойства абзаца.
Методы
METHOD GetClassType
Возвращает тип класса ApiParaPr.
METHOD GetIndFirstLine
Возвращает отступ первой строки в абзаце.
METHOD GetIndLeft
Возвращает левый боковой отступ абзаца.
METHOD GetIndRight
Возвращает правый боковой отступ в абзаце.
METHOD GetJc
Возвращает выравнивание содержимого в абзаце.
METHOD GetShd
Возвращает затенение, примененное к содержимому абзаца.
METHOD GetSpacingAfter
Возвращает значение интервала после текущего абзаца.
METHOD GetSpacingBefore
Возвращает интервал перед значением текущего абзаца.
METHOD GetSpacingLineRule
Возвращает правило межстрочного интервала абзаца.
METHOD GetSpacingLineValue
Возвращает значение межстрочного интервала абзаца.
METHOD GetStyle
Возвращает метод стиля абзаца.
METHOD SetBetweenBorder
Указывает границу, которая будет отображаться между каждым абзацем в наборе абзацев с одинаковым набором настроек границы абзаца.
METHOD SetBottomBorder
Указывает границу, которая будет отображаться под набором абзацев с одинаковыми настройками границы абзаца.
METHOD SetBullet
Устанавливает маркер или нумерацию для текущего абзаца.
METHOD SetContextualSpacing
Указывает, что любое пространство до или после этого абзаца, установленное с помощью элемента ApiParaPr#SetSpacingBefore или ApiParaPr#SetSpacingAfter, не должно применяться, если предыдущий и последующий абзацы имеют один и тот же стиль абзаца, что влияет на верхний и нижний интервалы соответственно.
METHOD SetIndFirstLine
Устанавливает отступ первой строки абзаца.
METHOD SetIndLeft
Устанавливает левый боковой отступ абзаца.
METHOD SetIndRight
Устанавливает правый боковой отступ абзаца.
METHOD SetJc
Устанавливает выравнивание содержимого абзаца.
METHOD SetKeepLines
Указывает, что при рендеринги документа с использованием постраничного просмотра все строки текущего абзаца по возможности сохраняются на одной странице.
METHOD SetKeepNext
Указывает, что при постраничном отображении документа содержимое текущего абзаца, по возможности, хотя бы частично отображается на той же странице, что и следующий абзац.
METHOD SetLeftBorder
Задает границу, которая будет отображаться в левой части страницы вокруг указанного абзаца.
METHOD SetNumPr
Указывает, что текущий абзац ссылается на экземпляр определения нумерации в текущем документе.
METHOD SetPageBreakBefore
Указывает, что при постраничном отображении документа содержимое текущего параграфа отображается в начале новой страницы документа.
METHOD SetRightBorder
Задает границу, которая будет отображаться в правой части страницы вокруг указанного абзаца.
METHOD SetShd
Определяет затенение, применяемое к содержимому абзаца.
METHOD SetSpacingAfter
Устанавливает интервал после текущего абзаца.
METHOD SetSpacingBefore
Устанавливает интервал перед текущим абзацем.
METHOD SetSpacingLine
Устанавливает межстрочный интервал абзаца.
METHOD SetStyle
Базовый метод стиля абзаца.
METHOD SetTabs
Указывает последовательность пользовательских ограничителей табуляции, которые будут использоваться для любых символов табуляции в текущем абзаце.
METHOD SetTopBorder
Определяет границу, которая будет отображаться над набором абзацев, имеющих одинаковые настройки границы абзаца.
METHOD SetWidowControl
Указывает, будет ли одна строка текущего абзаца отображаться на отдельной странице от остального содержимого при выводе на экран путем перемещения строки на следующую страницу.
METHOD ToJSON
Преобразует объект ApiParaPr в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oHeading6Style = oDocument.GetStyle("Heading 6");
var oParaPr = oHeading6Style.GetParaPr();
oParaPr.SetStyle(oHeading6Style);
oParaPr.SetJc("center");
var oParagraph = oDocument.GetElement(0);
oParagraph.SetStyle(oHeading6Style);
oParagraph.AddText("This is a text in a paragraph styled with the 'Heading 6' style.");
builder.SaveFile("docx", "ApiParaPr.docx");
builder.CloseFile();CLASS ApiPictureForm
new ApiPictureForm()
Класс, представляющий форму изображения документа.
Характеристики
| Название | Тип | Описание |
| scaleFlag | ScaleFlag | Условие масштабирования изображения на картинке: «всегда», «никогда», «слишком большое» или «слишком маленькое». |
| lockAspectRatio | логический | Указывает, заблокировано ли соотношение сторон формы изображения. |
| respectBorders | логический | Определяет, соблюдается или нет ширина границ формы при масштабировании изображения. |
| shiftX | процентный | Горизонтальное положение изображения внутри формы изображения, измеряемое в процентах:
|
| shiftY | процентный | Вертикальное положение изображения внутри формы изображения, измеряемое в процентах:
|
Методы
METHOD Clear
Унаследованный от: ApiFormBase#Clear.
Очищает текущую форму.
METHOD Copy
Унаследованный от: ApiFormBase#Copy.
Копирует текущую форму (копирует вместе с формой, если она существует).
METHOD GetClassType
Унаследованный от: ApiFormBase#GetClassType.
Возвращает тип класса ApiFormBase.
METHOD GetFormKey
Унаследовано от: ApiFormBase#GetFormKey
Возвращает текущий ключ формы.
METHOD GetFormType
Унаследованный от: ApiFormBase#GetFormType.
Возвращает тип текущей формы.
METHOD GetImage
Возвращает изображение в формате base64 из текущей формы изображения.
METHOD GetPicturePosition
Возвращает позицию изображения внутри текущей формы.
METHOD GetScaleFlag
Возвращает текущее состояние масштабирования формы изображения.
METHOD GetText
Унаследованный от: ApiFormBase#GetText.
Возвращает текст из текущей формы.
METHOD GetTextPr
Унаследованный от: ApiFormBase#GetTextPr.
Возвращает свойства текста из текущей формы.
METHOD GetTipText
Унаследованный от: ApiFormBase#GetTipText.
Возвращает текст подсказки текущей формы.
METHOD GetWrapperShape
Унаследованный от: ApiFormBase#GetWrapperShape.
Возвращает форму, в которую помещается форма для управления положением и размером рамки формы фиксированного размера.
METHOD IsFixed
Унаследованный от: ApiFormBase#IsFixed.
Проверяет, имеет ли текущая форма фиксированный размер.
METHOD IsLockAspectRatio
Проверяет, заблокировано или нет соотношение сторон текущей формы изображения.
METHOD IsRequired
Унаследованный от: ApiFormBase#IsRequired.
Проверяет, требуется ли текущая форма.
METHOD IsRespectBorders
Проверяет, соблюдается или нет ширина границы формы.
METHOD SetBackgroundColor
Унаследованный от: ApiFormBase#SetBackgroundColor.
Устанавливает цвет фона для текущей формы.
METHOD SetBorderColor
Унаследованный от: ApiFormBase#SetBorderColor.
Устанавливает цвет границы текущей формы.
METHOD SetFormKey
Унаследованный от: ApiFormBase#SetFormKey.
Задает ключ для текущей формы.
METHOD SetImage
Устанавливает изображение в текущую форму изображения.
METHOD SetLockAspectRatio
Фиксирует соотношение сторон текущего изображения.
METHOD SetPicturePosition
Устанавливает положение изображения внутри текущей формы.
METHOD SetPlaceholderText
Унаследованный от: ApiFormBase#SetPlaceholderText.
Устанавливает текст заполнителя в текущую форму.
METHOD SetRequired
Унаследованный от: ApiFormBase#SetRequired.
Указывает, требуется ли текущая форма.
METHOD SetRespectBorders
Соблюдает ширину границ формы при масштабировании изображения.
METHOD SetScaleFlag
Устанавливает условие масштабирования для текущей формы изображения.
METHOD SetTextPr
Унаследовано от: ApiFormBase#SetTextPr.
Устанавливает свойства текста в текущую форму.
METHOD SetTipText
Унаследованный от: ApiFormBase#SetTipText.
Устанавливает текст подсказки для текущей формы.
METHOD ToFixed
Унаследованный от: ApiFormBase#ToFixed.
Преобразует текущую форму в форму фиксированного размера.
METHOD ToInline
Унаследованный от: ApiFormBase#ToInline.
Преобразует текущую форму во встроенную форму.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oPictureForm = Api.CreatePictureForm({
"key": "Personal information",
"tip": "Upload your photo",
"required": true,
"placeholder": "Photo"
});
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oPictureForm);
oPictureForm.SetImage("https://api.onlyoffice.com/content/img/editor/opening.jpg");
oPictureForm.SetLockAspectRatio(true);
oPictureForm.SetScaleFlag("tooBig");
oPictureForm.SetPicturePosition(70, 70);
oPictureForm.SetRespectBorders(true);
var sScaleFlag = oPictureForm.GetScaleFlag();
var aPosition = oPictureForm.GetPicturePosition();
var bLock = oPictureForm.IsLockAspectRatio();
var bRespectBorders = oPictureForm.IsRespectBorders();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Picture scale flag: " + sScaleFlag);
oParagraph.AddLineBreak();
oParagraph.AddText("The aspect ratio of the first picture form in this document is locked: " + bLock);
oParagraph.AddLineBreak();
oParagraph.AddText("The borders of the first picture form in this document are respected when scaling the image: " + bRespectBorders);
oDocument.Push(oParagraph);
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Picture position: ");
oParagraph.AddLineBreak();
for (let i = 0; i < aPosition.length; i++) {
var nShift = aPosition[i];
oParagraph.AddText("" + nShift);
oParagraph.AddLineBreak();
}
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiPictureForm.docx");
builder.CloseFile();CLASS ApiPresetColor
new ApiPresetColor()
Класс, представляющий заданный цвет.
Методы
METHOD GetClassType
Возвращает тип класса ApiPresetColor.
METHOD ToJSON
Преобразует объект ApiPresetColor в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oPresetColor = Api.CreatePresetColor("lightYellow");
var oGs1 = Api.CreateGradientStop(oPresetColor, 0);
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 164, 101), 100000);
var oFill = Api.CreateRadialGradientFill([oGs1, oGs2]);
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oDrawing = Api.CreateShape("rect", 5930900, 395605, oFill, oStroke);
oParagraph.AddDrawing(oDrawing);
var sClassType = oPresetColor.GetClassType();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Class Type = " + sClassType);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiPresetColor.docx");
builder.CloseFile();CLASS ApiRange
new ApiRange(Start, End)
Класс, представляющий непрерывную область в документе. Каждый объект диапазона определяется положением начального и конечного символов.
Характеристики
| Название | Тип | Описание |
| Start | численный | Начальный элемент диапазона в текущем элементе. |
| End | численный | Конечный элемент диапазона в текущем элементе. |
Методы
METHOD AddBookmark
Добавляет закладку в указанный диапазон.
METHOD AddComment
Добавляет комментарий к текущему диапазону.
METHOD AddHyperlink
Добавляет гиперссылку к указанному диапазону.
METHOD AddText
Добавляет текст в указанную позицию.
METHOD Delete
Удаляет все содержимое из текущего диапазона.
METHOD ExpandTo
Возвращает новый диапазон, который выходит за пределы указанного диапазона в любом направлении и охватывает другой диапазон.
METHOD GetAllParagraphs
Возвращает коллекцию абзацев, которая представляет все абзацы в указанном диапазоне.
METHOD GetClassType
Возвращает тип класса ApiRange.
METHOD GetParagraph
Возвращает параграф из всех параграфов, которые находятся в диапазоне.
METHOD GetRange
Возвращает объект Range, представляющий часть документа, содержащуюся в указанном диапазоне.
METHOD GetText
Возвращает текст из указанного диапазона.
METHOD IntersectWith
Возвращает новый диапазон как пересечение текущего диапазона с другим диапазоном.
METHOD Select
Устанавливает выделение в заданном диапазоне.
METHOD SetBold
Устанавливает свойство полужирного шрифта в текстовый символ.
METHOD SetCaps
Указывает, что все символы нижнего регистра в текущем текстовом диапазоне форматируются для отображения только как эквиваленты заглавных букв.
METHOD SetColor
Устанавливает цвет текста на текущий текст Диапазон в формате RGB.
METHOD SetDoubleStrikeout
Указывает, что содержимое текущего диапазона отображается с двумя горизонтальными линиями через каждый символ, отображаемый в строке.
METHOD SetFontFamily
Устанавливает все 4 слота шрифтов с указанным семейством шрифтов.
METHOD SetFontSize
Устанавливает размер шрифта в символы текущего текстового диапазона.
METHOD SetHighlight
Определяет цвет выделения, который применяется в качестве фона к содержимому текущего диапазона.
METHOD SetItalic
Устанавливает свойство курсива на текстовый символ.
METHOD SetPosition
Определяет величину, на которую текст поднимается или опускается для текущего диапазона относительно базовой линии по умолчанию окружающего не позиционированного текста.
METHOD SetShd
Определяет затенение, применяемое к содержимому текущего текстового диапазона.
METHOD SetSmallCaps
Указывает, что все символы строчных букв в текущем текстовом диапазоне форматируются для отображения только как эквиваленты символов заглавных букв, которые на два пункта меньше фактического размера шрифта, указанного для данного текста.
METHOD SetSpacing
Устанавливает расстояние между текстами, измеряемое в двадцатых долях пунктам.
METHOD SetStrikeout
Указывает, что содержимое текущего диапазона отображается одной горизонтальной линией, проходящей через центр диапазона.
METHOD SetStyle
Устанавливает стиль для текущего диапазона.
METHOD SetTextPr
Задает свойства текста для текущего запуска.
METHOD SetUnderline
Указывает, что содержимое текущего диапазона отображается вместе со строкой, появляющейся непосредственно под символом (меньше всех интервалов над и под символами в строке).
METHOD SetVertAlign
Указывает выравнивание, которое будет применяться к содержимому диапазона по отношению к внешнему виду текста диапазона по умолчанию.
METHOD ToJSON
Преобразует объект ApiRange в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("This is just a sample text to demonstrate the methods for ApiRange. ");
oParagraph.GetRange(57, 64).AddBookmark("class ApiRange");
oParagraph.GetRange(57, 66).AddText("R7", "after");
oParagraph.GetRange(67, 76).AddHyperlink("https://support.r7-office.ru/category/using-api-document-builder/api-text-document/apirange/");
oParagraph.GetRange(67, 76).SetCaps(true);
oParagraph.GetRange(67, 76).SetSpacing(2);
oParagraph.GetRange(0, 3).SetColor(255, 164, 101);
oParagraph.GetRange(30, 40).SetFontFamily("Comic Sans MS");
oParagraph.GetRange(5, 6).SetFontSize(16);
oParagraph.GetRange(57, 65).SetBold(true);
oParagraph.GetRange(15, 20).SetDoubleStrikeout(true);
oParagraph.GetRange(13, 13).SetItalic(true);
oParagraph.GetRange(22, 25).SetUnderline(true);
oParagraph.GetRange(27, 28).SetSmallCaps(true);
oParagraph.GetRange(46, 52).SetShd("clear", 255, 224, 204);
oParagraph.GetRange(42, 44).SetStrikeout(true);
oParagraph.GetRange(7, 11).Delete();
builder.SaveFile("docx", "ApiRange.docx");
builder.CloseFile();CLASS ApiRGBColor
new ApiRGBColor()
Класс, представляющий RGB-цвет.
Методы
METHOD GetClassType
Возвращает тип класса ApiRGBColor.
METHOD ToJSON
Преобразует объект ApiRGBColor в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oRGBColor = Api.CreateRGBColor(255, 164, 101);
var oGs1 = Api.CreateGradientStop(Api.CreatePresetColor("lightYellow"), 0);
var oGs2 = Api.CreateGradientStop(oRGBColor, 100000);
var oFill = Api.CreateRadialGradientFill([oGs1, oGs2]);
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oDrawing = Api.CreateShape("rect", 5930900, 395605, oFill, oStroke);
oParagraph.AddDrawing(oDrawing);
var sClassType = oRGBColor.GetClassType();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Class Type = " + sClassType);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiRGBColor.docx");
builder.CloseFile();CLASS ApiRun
new ApiRun()
Класс, представляющий небольшой текстовый блок под названием «запуск».
Методы
METHOD AddColumnBreak
Добавляет разрыв колонки к текущей позиции выполнения и начинает следующий элемент с новой колонки.
METHOD AddComment
Добавляет комментарий к текущему запуску.
METHOD AddDrawing
Добавляет объект рисования (изображение, фигуру или диаграмму) к текущему текстовому прогону.
METHOD AddHyperlink
Добавляет гиперссылку к текущему запуску.
METHOD AddLineBreak
Добавляет разрыв строки к текущей позиции запуска и начинает следующий элемент с новой строки.
METHOD AddPageBreak
Добавляет разрыв страницы и начинает следующий элемент с новой страницы.
METHOD AddTabStop
Добавляет ограничение табуляции к текущему выполнению.
METHOD AddText
Добавляет текст к текущему запуску.
METHOD ClearContent
Очищает содержимое текущего запуска.
METHOD Copy
Создает копию текущего запуска.
METHOD Delete
Удаляет текущий запуск.
METHOD GetClassType
Возвращает тип класса ApiRun.
METHOD GetFontNames
Возвращает все имена шрифтов из всех элементов внутри текущего запуска.
METHOD GetParentContentControl
Возвращает элемент управления содержимым, содержащий текущий запуск
METHOD GetParentTable
Возвращает таблицу, содержащую текущую таблицу.
METHOD GetParentTableCell
Возвращает ячейку таблицы, содержащую текущий прогон.
METHOD GetRange
Возвращает объект Range, который представляет часть документа, содержащуюся в указанном запуске.
METHOD GetTextPr
Возвращает текстовые свойства текущего запуска.
METHOD RemoveAllElements
Удаляет все элементы из текущего запуска.
METHOD Select
Выбирает текущий запуск.
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
Указывает выравнивание, которое будет применяться к содержимому текущего запуска по отношению к внешнему виду текстового прогона по умолчанию.
METHOD ToJSON
Преобразует объект ApiRun в объект JSON.
METHOD WrapInMailMergeField
Обертывает запуск в поле для слияния почты.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oRun = Api.CreateRun();
oRun.AddText("This is just a sample text.");
oRun.AddLineBreak();
oRun.AddTabStop();
oRun.AddTabStop();
oRun.AddText(" Nothing special.");
oRun.SetBold(true);
oParagraph.AddElement(oRun);
var oCopyRun = oRun.Copy();
oParagraph.AddLineBreak();
oParagraph.AddElement(oCopyRun);
oRun = Api.CreateRun();
var oDrawing = Api.CreateChart("bar3D", [
[200, 240, 280],
[250, 260, 280]
], ["Projected Revenue", "Estimated Costs"], [2014, 2015, 2016], 4051300, 2347595, 24);
oDrawing.SetVerAxisTitle("USD In Hundred Thousands", 10);
oDrawing.SetHorAxisTitle("Year", 11);
oDrawing.SetLegendPos("bottom");
oDrawing.SetShowDataLabels(false, false, true, false);
oDrawing.SetTitle("Financial Overview", 13);
oRun.AddDrawing(oDrawing);
oParagraph.AddElement(oRun);
oRun = Api.CreateRun();
oRun.AddText("R7");
oRun.SetCaps(true);
oParagraph.AddLineBreak();
oParagraph.AddElement(oRun);
oRun.AddHyperlink("/", "main page");
builder.SaveFile("docx", "ApiRun.docx");
builder.CloseFile();CLASS ApiSchemeColor
new ApiSchemeColor()
Класс, представляющий цвет схемы.
Методы
METHOD GetClassType
Возвращает тип класса ApiSchemeColor.
METHOD ToJSON
Преобразует объект ApiSchemeColor в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oSchemeColor = Api.CreateSchemeColor("accent6");
var oFill = Api.CreateSolidFill(oSchemeColor);
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oDrawing = Api.CreateShape("curvedUpArrow", 5930900, 595605, oFill, oStroke);
oParagraph.AddDrawing(oDrawing);
var sClassType = oSchemeColor.GetClassType();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Class Type = " + sClassType);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiSchemeColor.docx");
builder.CloseFile();CLASS ApiSection
new ApiSection()
Класс, представляющий раздел документа.
Методы
METHOD GetClassType
Возвращает тип класса ApiSection.
METHOD GetFooter
Возвращает содержимое для указанного типа колонтитула.
METHOD GetHeader
Возвращает содержимое для указанного типа заголовка.
METHOD GetNext
Возвращает следующий раздел, если он существует.
METHOD GetPrevious
Возвращает предыдущий раздел, если он существует.
METHOD RemoveFooter
Удаляет нижний колонтитул заданного типа из текущего раздела.
METHOD RemoveHeader
Удаляет заголовок указанного типа из текущего раздела.
METHOD SetEqualColumns
Указывает, что все текстовые столбцы в текущем разделе имеют одинаковую ширину.
METHOD SetFooterDistance
Определяет расстояние от нижнего края страницы до нижнего края нижнего колонтитула.
METHOD SetHeaderDistance
Определяет расстояние от верхнего края страницы до верхнего края заголовка.
METHOD SetNotEqualColumns
Указывает, что все столбцы в текущем разделе имеют разную ширину.
METHOD SetPageMargins
Указывает поля страницы для всех страниц данного раздела.
METHOD SetPageSize
Указывает свойства (размер и ориентацию) для всех страниц в текущем разделе.
METHOD SetTitlePage
Указывает, имеет ли текущий раздел в этом документе другой верхний и нижний колонтитулы для первой страницы раздела.
METHOD SetType
Указывает тип текущего раздела.
METHOD ToJSON
Преобразует объект ApiSection в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oSection = oDocument.GetFinalSection();
oSection.SetEqualColumns(3, 720);
oParagraph.AddText("This is a text split into 3 equal columns. ");
oParagraph.AddText("The columns are separated by the distance of half an inch.");
oParagraph.AddColumnBreak();
oParagraph.AddText("This text starts from column #2. ");
oParagraph.AddText("This sentence is used to add lines for demonstrative purposes.");
oParagraph.AddColumnBreak();
oParagraph.AddText("This text starts from column #3. ");
oParagraph.AddText("This sentence is used to add lines for demonstrative purposes.");
var oFooter = oSection.GetFooter("default", true);
oSection.SetFooterDistance(1440);
oParagraph = oFooter.GetElement(0);
oParagraph.AddText("This is a page footer. ");
oParagraph.AddText("The distance from the page bottom to the footer is 1 inch (1440 twentieths of a point).");
var oHeader = oSection.GetHeader("default", true);
oSection.SetHeaderDistance(1440);
oParagraph = oHeader.GetElement(0);
oParagraph.AddText("This is a page header. ");
oParagraph.AddText("The distance from the page top to the header is 1 inch (1440 twentieths of a point).");
oSection.SetPageMargins(720, 720, 720, 720);
builder.SaveFile("docx", "ApiSection.docx");
builder.CloseFile();CLASS ApiShape
new ApiShape()
Класс, представляющий форму.
Методы
METHOD GetClassType
Возвращает тип класса ApiShape.
METHOD GetContent
Возвращает внутреннее содержимое формы, куда может быть вставлен абзац или текстовый запуск.
METHOD GetDocContent
Возвращает внутреннее содержимое фигуры, в которое можно вставить абзац или текст.
METHOD GetNextShape
Возвращает следующую встроенную фигуру, если она существует.
METHOD GetPrevShape
Возвращает предыдущую встроенную форму, если она существует.
METHOD SetPaddings
Устанавливает текстовые отступы в текущую форму.
METHOD SetVerticalTextAlign
Задает выравнивание по вертикали для содержимого фигуры, в которое можно вставить абзац или текст.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oFill = Api.CreateSolidFill(Api.CreateRGBColor(104, 155, 104));
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oDrawing = Api.CreateShape("rect", 3212465, 963295, oFill, oStroke);
oParagraph.AddDrawing(oDrawing);
var oDocContent = oDrawing.GetContent();
var sClassType = oDrawing.GetClassType();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Class Type = " + sClassType);
oDocContent.AddElement(0, oParagraph);
oDrawing.SetVerticalTextAlign("top");
builder.SaveFile("docx", "ApiShape.docx");
builder.CloseFile();CLASS ApiStroke
new ApiStroke()
Класс, представляющий штрих.
Методы
METHOD GetClassType
Возвращает тип класса ApiStroke.
METHOD ToJSON
Преобразует объект ApiStroke в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oRGBColor = Api.CreateRGBColor(0, 255, 0);
var oFill = Api.CreateSolidFill(oRGBColor);
var oStroke = Api.CreateStroke(5 * 36000, Api.CreateSolidFill(Api.CreateRGBColor(255, 224, 204)));
var oDrawing = Api.CreateShape("roundRect", 5930900, 395605, oFill, oStroke);
oParagraph.AddDrawing(oDrawing);
var sClassType = oStroke.GetClassType();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Class Type = " + sClassType);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiStroke.docx");
builder.CloseFile();CLASS ApiStyle
new ApiStyle()
Класс, представляющий собой стиль.
Методы
METHOD GetClassType
Возвращает тип класса ApiStyle.
METHOD GetConditionalTableStyle
Возвращает набор свойств форматирования, которые будут условно применяться к частям таблицы, соответствующим требованиям, указанным в параметре sType.
METHOD GetName
Возвращает имя текущего стиля.
METHOD GetParaPr
Возвращает свойства абзаца текущего стиля.
METHOD GetTableCellPr
Возвращает свойства ячейки таблицы текущего стиля.
METHOD GetTablePr
Возвращает свойства таблицы текущего стиля.
METHOD GetTableRowPr
Возвращает свойства строки таблицы текущего стиля.
METHOD GetTextPr
Возвращает свойства текста в текущем стиле.
METHOD GetType
Возвращает тип текущего стиля.
METHOD SetBasedOn
Задает ссылку на родительский стиль, от которого этот стиль наследует в иерархии стилей.
METHOD SetName
Задает имя текущего стиля.
METHOD ToJSON
Преобразует объект ApiStyle в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTableStyle = oDocument.CreateStyle("CustomTableStyle", "table");
oTableStyle.SetBasedOn(oDocument.GetStyle("Bordered - Accent 5"));
oTableStyle.SetName("My Custom Style");
var oTableStyleName = oTableStyle.GetName();
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("Table style name = " + oTableStyleName);
var oTable = Api.CreateTable(2, 2);
oTable.SetWidth("percent", 100);
var oTablePr = oTableStyle.GetTablePr();
oTablePr.SetTableInd(0);
oTablePr.SetTableCellMarginTop(720);
oTablePr.SetTableCellMarginLeft(120);
oTablePr.SetTableCellMarginRight(120);
oTablePr.SetTableCellMarginBottom(0);
oDocument.Push(oTable);
oTable.SetStyle(oTableStyle);
oTable.SetTableLook(true, true, true, true, true, true);
oTableStyle.GetConditionalTableStyle("topLeftCell").GetTableCellPr().SetShd("clear", 255, 0, 0);
oTableStyle.GetConditionalTableStyle("topRightCell").GetTableCellPr().SetShd("clear", 0, 255, 0);
oTableStyle.GetConditionalTableStyle("bottomLeftCell").GetTableCellPr().SetShd("clear", 0, 0, 255);
oTableStyle.GetConditionalTableStyle("bottomRightCell").GetTableCellPr().SetShd("clear", 255, 255, 0);
builder.SaveFile("docx", "ApiStyle.docx");
builder.CloseFile();CLASS ApiTable
new ApiTable()
Класс, представляющий таблицу.
Методы
METHOD AddColumn
Добавляет новый столбец в текущую таблицу.
METHOD AddColumns
Добавляет новые столбцы в текущую таблицу.
METHOD AddComment
Добавляет комментарий ко всему содержимому текущей таблицы.
METHOD AddElement
Добавляет абзац, таблицу или элемент управления содержимым blockLvl, используя его положение в ячейке.
METHOD AddRow
Добавляет новую строку в текущую таблицу.
METHOD AddRows
Добавляет новые строки в текущую таблицу.
METHOD Clear
Очищает содержимое таблицы.
METHOD Copy
Создает копию текущей таблицы.
METHOD Delete
Удаляет текущую таблицу.
METHOD GetCell
Возвращает ячейку по ее положению.
METHOD GetClassType
Возвращает тип класса ApiTable.
METHOD GetNext
Возвращает следующую таблицу, если она существует.
METHOD GetParentContentControl
Возвращает элемент управления содержимым, содержащий текущую таблицу.
METHOD GetParentTable
Возвращает родительскую таблицу текущей строки.
METHOD GetParentTableCell
Возвращает ячейку таблицы, содержащую текущую таблицу.
METHOD GetPosInParent
Возвращает позицию таблицы в ее родительском элементе.
METHOD GetPrevious
Возвращает предыдущую таблицу, если она существует.
METHOD GetRange
Возвращает объект Range, представляющий часть документа, содержащуюся в указанной таблице.
METHOD GetRow
Возвращает строку таблицы по ее положению в таблице.
METHOD GetRowsCount
Возвращает количество строк в текущей таблице.
METHOD GetTableDescription
Унаследованный от: ApiTablePr#GetTableDescription.
Возвращает описание таблицы.
METHOD GetTables
Возвращает таблицы, содержащие текущую таблицу.
METHOD GetTableTitle
Унаследованный от: ApiTablePr#GetTableTitle.
Возвращает заголовок таблицы (caption).
METHOD InsertInContentControl
Обертывает текущий объект таблицы элементом управления содержимым.
METHOD MergeCells
Объединяет массив ячеек.
METHOD RemoveColumn
Удаляет столбец таблицы с указанной ячейкой.
METHOD RemoveRow
Удаляет строку таблицы с указанной ячейкой.
METHOD ReplaceByElement
Заменяет текущую таблицу новым элементом.
METHOD Search
Выполняет поиск области видимости объекта таблицы.
METHOD Select
Выбирает текущую таблицу.
METHOD SetBackgroundColor
Устанавливает цвет фона для всех ячеек в текущей таблице.
METHOD SetCellSpacing
Унаследованный от: ApiTablePr#SetCellSpacing.
Задает интервал между ячейками таблицы по умолчанию (расстояние между соседними ячейками и краями таблицы).
METHOD SetHAlign
Устанавливает горизонтальное выравнивание таблицы.
METHOD SetJc
Унаследованный от: ApiTablePr#SetJc.
Указывает выравнивание текущей таблицы относительно текстовых полей в текущем разделе.
METHOD SetPaddings
Устанавливает отступы таблицы.
METHOD SetShd
Унаследованный от: ApiTablePr#SetShd.
Определяет затенение, которое применяется к экстентам текущей таблицы.
METHOD SetStyle
Устанавливает стиль для текущей таблицы.
METHOD SetStyleColBandSize
Унаследованное от ApiTablePr#SetStyleColBandSize.
Указывает количество столбцов, которые будут составлять каждый диапазон столбцов таблицы для данного стиля таблицы.
METHOD SetStyleRowBandSize
Унаследованный от: ApiTablePr#SetStyleRowBandSize.
Указывает количество строк, которые будут составлять каждую полосу строк таблицы для данного стиля таблицы.
METHOD SetTableBorderBottom
Унаследованный от: ApiTablePr#SetTableBorderBottom.
Устанавливает границу, которая будет отображаться внизу текущей таблицы.
METHOD SetTableBorderInsideH
унаследованный от: ApiTablePr#SetTableBorderInsideH.
Указывает границу, которая будет отображаться на всех горизонтальных границах ячеек таблицы, которые не находятся на самом дальнем краю родительской таблицы (все горизонтальные границы, которые не являются самой верхней или самой нижней границей).
METHOD SetTableBorderInsideV
Унаследованный от: ApiTablePr#SetTableBorderInsideV.
Указывает границу, которая будет отображаться на всех вертикальных границах ячеек таблицы, которые не находятся на крайнем краю родительской таблицы (все вертикальные границы, которые не являются крайними левыми или правыми границами).
METHOD SetTableBorderLeft
Унаследованный от: ApiTablePr#SetTableBorderLeft.
Устанавливает границу, которая будет отображаться слева от текущей таблицы.
METHOD SetTableBorderRight
Унаследованный от: ApiTablePr#SetTableBorderRight.
Устанавливает границу, которая будет отображаться справа от текущей таблицы.
METHOD SetTableBorderTop
Унаследованный от: ApiTablePr#SetTableBorderTop.
Устанавливает границу, которая будет отображаться в верхней части текущей таблицы.
METHOD SetTableCellMarginBottom
Унаследованный от: ApiTablePr#SetTableCellMarginBottom.
Указывает количество пространства, которое будет оставлено между нижней границей содержимого ячейки и границей всех ячеек таблицы в пределах родительской таблицы (или строки таблицы).
METHOD SetTableCellMarginLeft
Унаследованный от: ApiTablePr#SetTableCellMarginLeft.
Указывает количество пространства, которое будет оставлено между левой границей содержимого ячейки и левой границей всех ячеек таблицы в пределах родительской таблицы (или строки таблицы).
METHOD SetTableCellMarginRight
Унаследованный от: ApiTablePr#SetTableCellMarginRight.
Указывает количество пространства, которое будет оставлено между правой границей содержимого ячейки и правой границей всех ячеек таблицы в пределах родительской таблицы (или строки таблицы).
METHOD SetTableCellMarginTop
Унаследованный от: ApiTablePr#SetTableCellMarginTop.
Указывает количество пространства, которое будет оставлено между верхней границей содержимого ячейки и верхней границей всех ячеек таблицы в пределах родительской таблицы (или строки таблицы).
METHOD SetTableDescription
Унаследовано от: ApiTablePr#SetTableDescription.
Устанавливает описание таблицы.
METHOD SetTableInd
Унаследовано от: ApiTablePr#SetTableInd Указывает отступ, который будет добавлен перед передним краем текущей таблицы в документе (левый край в таблице слева направо и правый край в таблице справа налево).
METHOD SetTableLayout
Унаследовано от: ApiTablePr#SetTableLayout.
Указывает алгоритм, который будет использоваться для размещения содержимого текущей таблицы в документе.
METHOD SetTableLook
Указывает компоненты условного форматирования ссылаемого стиля таблицы (если он существует), которые должны применяться к набору строк таблицы с текущими исключениями свойств на уровне таблицы.
METHOD SetTableTitle
Задает заголовок таблицы (caption).
METHOD SetTextPr
Унаследованный от: ApiFormBase#SetTextPr.
Устанавливает свойства текста для текущей формы.
METHOD SetVAlign
Задает вертикальное выравнивание таблицы.
METHOD SetWidth
Унаследовано от: ApiTablePr#SetWidth.
Устанавливает предпочтительную ширину для текущей таблицы.
METHOD SetWrappingStyle
Устанавливает стиль обтекания таблицы.
METHOD Split
Разбивает ячейку на заданное количество строк и столбцов.
METHOD ToJSON
Преобразует объект ApiTable в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTable = Api.CreateTable(5, 5);
oTable.SetWidth("percent", 100);
oTable.AddColumn(oTable.GetRow(0).GetCell(1), true);
oTable.AddRow(oTable.GetRow(1).GetCell(0), true);
var oCopyTable = oTable.Copy();
var oTableStyle = oDocument.CreateStyle("CustomTableStyle", "table");
oTableStyle.SetBasedOn(oDocument.GetStyle("Bordered - Accent 5"));
oTable.SetStyle(oTableStyle);
var oParagraph = Api.CreateParagraph();
oParagraph.AddText("Merged cell");
var oCell = oTable.MergeCells([oTable.GetRow(1).GetCell(1), oTable.GetRow(1).GetCell(2), oTable.GetRow(2).GetCell(1), oTable.GetRow(2).GetCell(2)]);
oTable.AddElement(oCell, 0, oParagraph);
var oBlockLvlSdt = oTable.InsertInContentControl(1);
oDocument.AddElement(0, oBlockLvlSdt);
var sClassType = oTable.GetClassType();
oParagraph = oDocument.GetElement(0);
oParagraph.AddText("Class Type = " + sClassType);
var aSearch = oTable.Search("cell");
aSearch[0].SetBold(true);
oCopyTable.SetHAlign("center");
oCopyTable.SetTableBorderTop("single", 4, 0, 0, 0, 255);
oCopyTable.SetTableBorderBottom("single", 32, 0, 0, 0, 255);
oCopyTable.SetTableBorderLeft("single", 4, 0, 0, 0, 255);
oCopyTable.SetTableBorderRight("single", 4, 0, 0, 0, 255);
oCopyTable.SetTableBorderInsideV("single", 4, 0, 255, 0, 0);
oCopyTable.SetTableBorderInsideH("single", 4, 0, 255, 0, 0);
oDocument.Push(oCopyTable);
builder.SaveFile("docx", "ApiTable.docx");
builder.CloseFile();CLASS ApiTableCell
new ApiTableCell()
Класс, представляющий ячейку таблицы.
Методы
METHOD AddColumns
Добавляет новые столбцы в текущую таблицу.
METHOD AddElement
Унаследованный от: ApiDocumentContent#AddElement.
Добавляет абзац, таблицу или элемент управления содержимым blockLvl, используя его положение в содержимом документа.
METHOD AddRows
Добавляет новые строки в текущую таблицу.
METHOD Clear
Удаляет содержимое из текущей строки.
METHOD GetClassType
Возвращает тип класса ApiTableCell.
METHOD GetContent
Возвращает внутреннее содержимое формы, куда может быть вставлен абзац или текстовый прогон.
METHOD GetIndex
Возвращает индекс текущей строки.
METHOD GetNext
Возвращает следующую ячейку, если она существует.
METHOD GetParentRow
Возвращает родительскую строку текущей ячейки.
METHOD GetParentTable
Возвращает родительскую таблицу текущей ячейки.
METHOD GetPrevious
Возвращает предыдущую строку, если она существует.
METHOD GetRowIndex
Возвращает индекс родительской строки.
METHOD RemoveColumn
Удаляет столбец, содержащий текущую ячейку.
METHOD RemoveRow
Удаляет строку, содержащую текущую ячейку.
METHOD Search
Выполняет поиск области видимости объекта строки таблицы.
METHOD SetBackgroundColor
Задает цвет фона для всех ячеек в текущей строке таблицы.
METHOD SetCellBorderBottom
Унаследовано от: ApiTableCellPr#SetCellBorderBottom.
Устанавливает границу, которая будет отображаться внизу текущей ячейки таблицы.
METHOD SetCellBorderLeft
Унаследовано от: ApiTableCellPr#SetCellBorderLeft.
Устанавливает границу, которая будет отображаться слева от текущей ячейки таблицы.
METHOD SetCellBorderRight
Унаследовано от: ApiTableCellPr#SetCellBorderRight.
Устанавливает границу, которая будет отображаться справа от текущей ячейки таблицы.
METHOD SetCellBorderTop
Унаследовано от: ApiTableCellPr#SetCellBorderTop.
Устанавливает границу, которая будет отображаться в верхней части текущей ячейки таблицы.
METHOD SetCellMarginBottom
Унаследовано от: ApiTableCellPr#SetCellMarginBottom.
Определяет расстояние, которое останется между нижней границей содержимого ячейки и границей конкретной ячейки таблицы в таблице.
METHOD SetCellMarginLeft
Унаследовано от: ApiTableCellPr#SetCellMarginLeft.
Определяет расстояние, которое останется между левым экстентом содержимого ячейки и границей конкретной ячейки таблицы в таблице.
METHOD SetCellMarginRight
Унаследовано от: ApiTableCellPr#SetCellMarginRight.
Определяет пространство, которое будет оставлено между правым экстентом содержимого ячейки и границей конкретной ячейки таблицы в таблице.
METHOD SetCellMarginTop
Унаследовано от: ApiTableCellPr#SetCellMarginTop.
Задает расстояние, которое останется между верхним пределом содержимого ячейки и границей конкретной ячейки таблицы в таблице.
METHOD SetCellPr
Задает свойства ячейки для текущей ячейки.
METHOD SetColumnBackgroundColor
Задает цвет фона для всех ячеек в столбце, содержащем текущую ячейку.
METHOD SetNoWrap
Унаследовано от: ApiTableCellPr#SetNoWrap.
Указывает, как размещается текущая ячейка таблицы, когда родительская таблица отображается в документе.
METHOD SetShd
Унаследовано от: ApiTableCellPr#SetShd.
Задает затенение, применяемое к содержимому ячейки таблицы.
METHOD SetTextDirection
Унаследовано от: ApiTableCellPr#SetTextDirection.
Указывает направление потока текста для этой ячейки таблицы.
METHOD SetTextPr
Применяет параметры текста ко всему содержимому текущей ячейки.
METHOD SetVerticalAlign
Унаследовано от: ApiTableCellPr#SetVerticalAlign.
Указывает вертикальное выравнивание текстового содержимого в текущей ячейке таблицы.
METHOD SetWidth
Унаследовано от: ApiTableCellPr#SetWidth.
Устанавливает предпочтительную ширину для текущей ячейки таблицы.
METHOD Split
Разбивает ячейку на заданное количество строк и столбцов.
METHOD ToJSON
Унаследованный от: ApiTableRowPr#ToJSON.
Преобразует объект ApiTableRowPr в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTableStyle = oDocument.CreateStyle("CustomTableStyle", "table");
oTableStyle.SetBasedOn(oDocument.GetStyle("Bordered"));
var oTable = Api.CreateTable(1, 1);
oTable.SetWidth("percent", 100);
var oCell = oTable.GetCell(0, 0);
oCell.AddColumns(2, false);
oCell.AddRows(2, false);
var oParentRow = oCell.GetParentRow();
oParentRow.SetHeight("atLeast", 1440);
var oParentTable = oCell.GetParentTable();
oParentTable.SetTableBorderBottom("single", 4, 0, 255, 111, 61);
oCell.SetVerticalAlign("top");
var oParagraph = oCell.GetContent().GetElement(0);
oParagraph.AddText("Align top");
oCell = oTable.GetRow(0).GetCell(1);
oCell.SetVerticalAlign("center");
oParagraph = oCell.GetContent().GetElement(0);
oParagraph.AddText("Align center");
oCell = oTable.GetRow(0).GetCell(2);
oCell.SetVerticalAlign("bottom");
oParagraph = oCell.GetContent().GetElement(0);
oParagraph.AddText("Align bottom");
oTable.SetStyle(oTableStyle);
var oNextCell = oTable.GetCell(0, 1).GetNext();
oNextCell.GetContent().GetElement(0).SetBold(true);
var oPreviousCell = oTable.GetCell(0, 1).GetPrevious();
oPreviousCell.GetContent().GetElement(0).SetBold(true);
oCell = oTable.GetRow(0).GetCell(0);
oCell.SetCellBorderBottom("single", 32, 0, 51, 51, 51);
oCell.SetCellBorderLeft("single", 32, 0, 51, 51, 51);
oCell.SetCellBorderRight("single", 32, 0, 51, 51, 51);
oCell.SetCellBorderTop("single", 32, 0, 51, 51, 51);
oTable.GetCell(1, 0).GetContent().GetElement(0).AddText("Cell index: " + oTable.GetCell(1, 0).GetIndex());
oDocument.Push(oTable);
var sClassType = oCell.GetClassType();
oParagraph = oDocument.GetElement(0);
oParagraph.AddText("Class Type = " + sClassType);
builder.SaveFile("docx", "ApiTableCell.docx");
builder.CloseFile();CLASS ApiTableCellPr
new ApiTableCellPr()
Класс, представляющий свойства ячейки таблицы.
Методы
METHOD GetClassType
Возвращает тип класса ApiTableCellPr.
METHOD SetCellBorderBottom
Устанавливает границу, которая будет отображаться внизу текущей ячейки таблицы.
METHOD SetCellBorderLeft
Устанавливает границу, которая будет отображаться слева от текущей ячейки таблицы.
METHOD SetCellBorderRight
Устанавливает границу, которая будет отображаться справа от текущей ячейки таблицы.
METHOD SetCellBorderTop
Устанавливает границу, которая будет отображаться в верхней части текущей ячейки таблицы.
METHOD SetCellMarginBottom
Определяет расстояние, которое останется между нижней границей содержимого ячейки и границей конкретной ячейки таблицы в таблице.
METHOD SetCellMarginLeft
Устанавливает размер пространства между левой границей содержимого ячейки и левой границей самой ячейки в таблице.
METHOD SetCellMarginRight
Определяет пространство, которое будет оставлено между правым экстентом содержимого ячейки и границей конкретной ячейки таблицы в таблице.
METHOD SetCellMarginTop
Задает расстояние, которое останется между верхним пределом содержимого ячейки и границей конкретной ячейки таблицы в таблице.
METHOD SetNoWrap
Указывает, как размещается текущая ячейка таблицы, когда родительская таблица отображается в документе.
METHOD SetShd
Задает затенение, применяемое к содержимому ячейки таблицы.
METHOD SetTextDirection
Указывает направление потока текста для этой ячейки таблицы.
METHOD SetVerticalAlign
Указывает вертикальное выравнивание текстового содержимого в текущей ячейке таблицы.
METHOD SetWidth
Устанавливает предпочтительную ширину для текущей ячейки таблицы.
METHOD ToJSON
Преобразует объект ApiTableCellPr в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTableStyle = oDocument.CreateStyle("CustomTableStyle", "table");
oTableStyle.SetBasedOn(oDocument.GetStyle("Bordered"));
var oTable = Api.CreateTable(3, 3);
oTable.SetWidth("percent", 100);
var oTableRow = oTable.GetRow(0);
oTableRow.SetHeight("atLeast", 1440);
var oTableCellPr = oTableStyle.GetTableCellPr();
oTableCellPr.SetVerticalAlign("bottom");
oTableCellPr.SetCellBorderRight("single", 32, 0, 51, 51, 51);
oTableCellPr.SetCellBorderTop("single", 32, 0, 51, 51, 51);
oTableCellPr.SetShd("clear", 255, 111, 61, false);
var oCell = oTable.GetRow(0).GetCell(0);
var oParagraph = oCell.GetContent().GetElement(0);
oParagraph.AddText("Align bottom");
oTable.SetStyle(oTableStyle);
oDocument.Push(oTable);
var sClassType = oTableCellPr.GetClassType();
oParagraph = oDocument.GetElement(0);
oParagraph.AddText("Class Type = " + sClassType);
builder.SaveFile("docx", "ApiTableCellPr.docx");
builder.CloseFile();CLASS ApiTablePr
new ApiTablePr()
Класс, представляющий свойства таблицы.
Методы
METHOD GetClassType
Возвращает тип класса ApiTablePr.
METHOD GetTableDescription
Возвращает описание таблицы.
METHOD GetTableTitle
Возвращает заголовок таблицы (caption).
METHOD SetCellSpacing
Задает интервал между ячейками таблицы по умолчанию (расстояние между соседними ячейками и краями таблицы).
METHOD SetJc
Указывает выравнивание текущей таблицы относительно текстовых полей в текущем разделе.
METHOD SetShd
Указывает затенение, которое применяется к экстентам текущей таблицы.
METHOD SetStyleColBandSize
Указывает количество столбцов, которые будут содержать каждую полосу столбца таблицы для этого стиля таблицы.
METHOD SetStyleRowBandSize
Указывает количество строк, которые будут содержать каждую полосу строк таблицы для этого стиля таблицы.
METHOD SetTableBorderBottom
Устанавливает границу, которая будет отображаться внизу текущей таблицы.
METHOD SetTableBorderInsideH
Указывает границу, которая будет отображаться на всех горизонтальных границах ячеек таблицы, которые не находятся на самом дальнем краю родительской таблицы (все горизонтальные границы, которые не являются самой верхней или самой нижней границей).
METHOD SetTableBorderInsideV
Указывает границу, которая будет отображаться на всех вертикальных границах ячеек таблицы, которые не находятся на самом дальнем краю родительской таблицы (все вертикальные границы, которые не являются крайними левыми или крайними правыми границами).
METHOD SetTableBorderLeft
Устанавливает границу, которая будет отображаться слева от текущей таблицы.
METHOD SetTableBorderRight
Устанавливает границу, которая будет отображаться справа от текущей таблицы.
METHOD SetTableBorderTop
Устанавливает границу, которая будет отображаться в верхней части текущей таблицы.
METHOD SetTableCellMarginBottom
Задает расстояние, которое останется между нижней границей содержимого ячейки и границей всех ячеек таблицы в родительской таблице (или строке таблицы).
METHOD SetTableCellMarginLeft
Задает расстояние, которое останется между левой границей содержимого ячейки и левой границей всех ячеек таблицы в родительской таблице (или строке таблицы).
METHOD SetTableCellMarginRight
Задает расстояние, которое останется между правой границей содержимого ячейки и правой границей всех ячеек таблицы в родительской таблице (или строке таблицы).
METHOD SetTableCellMarginTop
Задает расстояние, которое останется между верхней границей содержимого ячейки и верхней границей всех ячеек таблицы в родительской таблице (или строке таблицы).
METHOD SetTableDescription
Устанавливает описание таблицы.
METHOD SetTableInd
Указывает отступ, который будет добавлен перед передним краем текущей таблицы в документе (левый край в таблице слева направо и правый край в таблице справа налево).
METHOD SetTableLayout
Указывает алгоритм, который будет использоваться для размещения содержимого текущей таблицы в документе.
METHOD SetTableTitle
Задает заголовок таблицы (caption).
METHOD SetWidth
Устанавливает предпочтительную ширину для текущей таблицы.
METHOD ToJSON
Преобразует объект ApiTablePr в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTableStyle = oDocument.CreateStyle("CustomTableStyle", "table");
oTableStyle.SetBasedOn(oDocument.GetStyle("Bordered"));
var oTablePr = oTableStyle.GetTablePr();
oTablePr.SetJc("center");
oTablePr.SetCellSpacing(720);
oTablePr.SetTableBorderBottom("single", 32, 0, 51, 51, 51);
oTablePr.SetTableBorderLeft("single", 32, 0, 51, 51, 51);
oTablePr.SetTableBorderRight("single", 32, 0, 51, 51, 51);
oTablePr.SetTableBorderTop("single", 32, 0, 51, 51, 51);
oTablePr.SetWidth("percent", 100);
var oTable = Api.CreateTable(4, 2);
oTable.SetTableLook(true, true, true, true, true, true);
oTablePr.SetStyleColBandSize(2);
oTableStyle.GetConditionalTableStyle("bandedColumn").GetTextPr().SetBold(true);
oTable.GetRow(0).GetCell(0).GetContent().GetElement(0).AddText("Bold");
oTable.GetRow(0).GetCell(1).GetContent().GetElement(0).AddText("Bold");
oTable.GetRow(0).GetCell(2).GetContent().GetElement(0).AddText("Normal");
oTable.GetRow(0).GetCell(3).GetContent().GetElement(0).AddText("Normal");
oTable.GetRow(1).GetCell(0).GetContent().GetElement(0).AddText("Bold");
oTable.GetRow(1).GetCell(1).GetContent().GetElement(0).AddText("Bold");
oTable.GetRow(1).GetCell(2).GetContent().GetElement(0).AddText("Normal");
oTable.GetRow(1).GetCell(3).GetContent().GetElement(0).AddText("Normal");
oTable.SetStyle(oTableStyle);
var sClassType = oTablePr.GetClassType();
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("Class Type = " + sClassType);
oDocument.Push(oTable);
builder.SaveFile("docx", "ApiTablePr.docx");
builder.CloseFile();CLASS ApiTableRow
new ApiTableRow()
Класс, представляющий строку таблицы.
Методы
METHOD AddRows
Добавляет новые строки в текущую таблицу.
METHOD Clear
Очищает содержимое текущей строки.
METHOD GetCell
Возвращает ячейку по ее положению.
METHOD GetCellsCount
Возвращает количество ячеек в текущей строке.
METHOD GetClassType
Возвращает тип класса ApiTableRow.
METHOD GetIndex
Возвращает индекс листа.
METHOD GetNext
Возвращает следующую строку, если она существует.
METHOD GetParentTable
Возвращает родительскую таблицу текущей строки.
METHOD GetPrevious
Возвращает предыдущую строку, если она существует.
METHOD MergeCells
Объединяет ячейки в текущей строке.
METHOD Remove
Удаляет текущую строку таблицы.
METHOD Search
Ищет область объекта строки таблицы.
METHOD SetBackgroundColor
Задает цвет фона для всех ячеек в текущей строке таблицы.
METHOD SetHeight
Унаследованный от: ApiTableRowPr#SetHeight.
Задает высоту текущей строки таблицы в пределах текущей таблицы.
METHOD SetTableHeader
Унаследованный от: ApiTableRowPr#SetTableHeader.
Указывает, что текущая строка таблицы будет повторяться в верхней части каждой новой страницы, где бы ни отображалась эта таблица.
METHOD SetTextPr
Задает свойства текста для текущей строки.
METHOD ToJSON
Унаследовано от: ApiTableRowPr#ToJSON.
Преобразует объект ApiTableRowPr в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTableStyle = oDocument.CreateStyle("CustomTableStyle", "table");
oTableStyle.SetBasedOn(oDocument.GetStyle("Bordered"));
var oTable = Api.CreateTable(3, 3);
oTable.SetWidth("percent", 100);
var oTableRow = oTable.GetRow(0);
oTableRow.SetHeight("atLeast", 720);
oTableRow.AddRows(1, true);
oTableRow = oTable.GetRow(0);
var oCell = oTableRow.GetCell(1);
oCell.SetVerticalAlign("bottom");
var oParagraph = oCell.GetContent().GetElement(0);
oParagraph.AddText("Align bottom");
var nCellsCount = oTableRow.GetCellsCount();
oTableRow.GetCell(0).GetContent().GetElement(0).AddText("Row index: " + oTableRow.GetIndex());
oTableRow = oTable.GetRow(1);
oTableRow.GetCell(0).GetContent().GetElement(0).AddText("Second row");
oTableRow.GetNext().GetCell(0).GetContent().GetElement(0).AddText("Third row");
oTableRow.GetPrevious().GetCell(1).GetContent().GetElement(0).SetBold(true);
oTableRow = oTable.GetRow(2);
oTableRow.MergeCells();
oTable.SetStyle(oTableStyle);
oDocument.Push(oTable);
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Number of cells in the first row = " + nCellsCount);
var sClassType = oTableRow.GetClassType();
oParagraph.AddLineBreak();
oParagraph.AddText("Class Type = " + sClassType);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiTableRow.docx");
builder.CloseFile();CLASS ApiTableRowPr
new ApiTableRowPr()
Класс, представляющий свойства строки таблицы.
Методы
METHOD GetClassType
Возвращает тип класса ApiTableRowPr.
METHOD SetHeight
Задает высоту текущей строки таблицы в пределах текущей таблицы.
METHOD SetTableHeader
Указывает, что текущая строка таблицы будет повторяться в верхней части каждой новой страницы, на которой отображается эта таблица.
METHOD ToJSON
Преобразует объект ApiTableRowPr в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTableStyle = oDocument.CreateStyle("CustomTableStyle", "table");
oTableStyle.SetBasedOn(oDocument.GetStyle("Bordered"));
var oTable = Api.CreateTable(3, 3);
oTable.SetWidth("percent", 100);
oTable.SetTableLook(true, true, true, true, false, false);
var oTableRowPr = oTableStyle.GetTableRowPr();
oTableRowPr.SetTableHeader(true);
oTableRowPr.SetHeight("atLeast", 720);
oTable.SetStyle(oTableStyle);
oDocument.Push(oTable);
var sClassType = oTableRowPr.GetClassType();
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("Class Type = " + sClassType);
oParagraph.AddLineBreak();
oParagraph.AddText("We create a 3x3 table and set all table rows as the table headers:");
builder.SaveFile("docx", "ApiTableRowPr.docx");
builder.CloseFile();CLASS ApiTableStylePr
new ApiTableStylePr()
Класс, представляющий набор свойств форматирования, которые должны условно применяться к частям таблицы, соответствующим требованию, указанному в Типе.
Методы
METHOD GetClassType
Возвращает тип класса ApiTableStylePr.
METHOD GetParaPr
Возвращает набор свойств абзаца, которые будут применены ко всем абзацам в таблице, соответствующим типу условного форматирования.
METHOD GetTableCellPr
Возвращает набор свойств ячейки таблицы, которые будут применены ко всем ячейкам таблицы, соответствующим типу условного форматирования.
METHOD GetTablePr
Возвращает набор свойств таблицы, которые будут применены ко всем областям в таблице, соответствующим типу условного форматирования.
METHOD GetTableRowPr
Возвращает набор свойств строки таблицы, которые будут применены ко всем строкам таблицы, соответствующим типу условного форматирования.
METHOD GetTextPr
Возвращает набор свойств прогона текста, которые будут применяться ко всем прогонам текста в таблице, соответствующим типу условного форматирования.
METHOD GetType
Возвращает тип текущего условного стиля таблицы.
METHOD ToJSON
Преобразует объект ApiTableStylePr в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTableStyle = oDocument.CreateStyle("CustomTableStyle", "table");
oTableStyle.SetBasedOn(oDocument.GetStyle("Bordered"));
var oTable = Api.CreateTable(3, 3);
oTable.SetWidth("percent", 100);
oTable.SetTableLook(true, true, true, true, false, false);
var oTableRowPr = oTableStyle.GetTableRowPr();
oTableRowPr.SetTableHeader(true);
oTableRowPr.SetHeight("atLeast", 720);
oTable.SetStyle(oTableStyle);
oDocument.Push(oTable);
var sClassType = oTableRowPr.GetClassType();
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("Class Type = " + sClassType);
oParagraph.AddLineBreak();
oParagraph.AddText("We create a 3x3 table and set all table rows as the table headers:");
builder.SaveFile("docx", "ApiTableRowPr.docx");
builder.CloseFile();CLASS ApiTextForm
new ApiTextForm()
Класс, представляющий текстовое поле документа.
Характеристики
| Название | Тип | Описание |
| comb | логический | Указывает, должно ли текстовое поле представлять собой набор символов с одинаковой шириной ячейки. Максимальное количество символов должно быть установлено на положительное значение. |
| maxCharacters | числовой | Максимальное количество символов в текстовом поле. |
| cellWidth | числовой | Ширина ячейки для каждого символа измеряется в миллиметрах. Если этот параметр не указан или равен 0 или меньше, то ширина будет установлена автоматически. |
| multiLine | логический | Указывает, является ли текущее текстовое поле фиксированного размера многострочным или нет. |
| autoFit | логический | Указывает, должно ли содержимое текстового поля подгоняться автоматически, т. е. подстраивается ли размер шрифта под размер формы фиксированного размера. |
Методы
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTextForm = Api.CreateTextForm({"key": "Personal information", "tip": "Enter your first name", "required": true, "placeholder": "First name", "multiLine": false, "autoFit": false});
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oTextForm);
oTextForm.SetCharactersLimit(5);
oTextForm.SetText("John Smith");
oTextForm.SetComb(true);
var nLimit = oTextForm.GetCharactersLimit();
var bComb = oTextForm.IsComb();
var bMultiline = oTextForm.IsMultiline();
var bAutoFit = oTextForm.IsAutoFit();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Characters limit: " + nLimit);
oParagraph.AddLineBreak();
oParagraph.AddText("The first text form from this document is comb: " + bComb);
oParagraph.AddLineBreak();
oParagraph.AddText("The first text form from this document is multiline: " + bMultiline);
oParagraph.AddLineBreak();
oParagraph.AddText("The first text form from this document is autofit: " + bAutoFit);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiTextForm.docx");
builder.CloseFile();CLASS ApiTextPr
new ApiTextPr()
Класс, представляющий свойства текста.
Методы
METHOD GetClassType
Возвращает тип класса ApiTextPr.
METHOD SetBold
Устанавливает свойство полужирного шрифта в текстовый символ.
METHOD SetCaps
Указывает, что любые символы нижнего регистра в текстовом прогоне форматируются для отображения только как их эквиваленты символов заглавных букв.
METHOD SetColor
Устанавливает цвет текста в соответствии с текущим текстом в формате RGB.
METHOD SetDoubleStrikeout
Указывает, что содержимое прогона отображается с двумя горизонтальными линиями через каждый символ, отображаемый в строке.
METHOD SetFill
Устанавливает цвет текста в соответствии с текущим цветом текста.
METHOD SetFontFamily
Устанавливает все 4 слота шрифтов с указанным семейством шрифтов.
METHOD SetFontSize
Устанавливает размер шрифта в соответствии с символами текущего запуска текста.
METHOD SetHighlight
Указывает цвет выделения, который добавляется к свойствам текста и применяется в качестве фона к содержимому текущего запуска/диапазона/абзаца.
METHOD SetItalic
Устанавливает свойство курсива на текстовый символ.
METHOD SetLanguage
Указывает языки, которые будут использоваться для проверки орфографии и грамматики (если требуется) при обработке содержимого текстового прогона.
METHOD SetOutLine
Устанавливает контур текста на текущий запуск текста.
METHOD SetPosition
Определяет величину, на которую текст поднимается или опускается для этого прогона по отношению к базовой линии по умолчанию для окружающего не позиционированного текста.
METHOD SetShd
Определяет затенение, применяемое к содержимому текущего прогона текста.
METHOD SetSmallCaps
Указывает, что все символы строчных букв в текстовом прогоне форматируются для отображения только как их эквиваленты символов заглавных букв, которые на две точки меньше, чем фактический размер шрифта, указанный для этого текста.
METHOD SetSpacing
Устанавливает расстояние между текстами, измеряемое в двадцатых долях точки.
METHOD SetStrikeout
Указывает, что содержимое запуска отображается одной горизонтальной линией, проходящей через центр строки.
METHOD SetStyle
Базовый метод текстового стиля.
METHOD SetTextFill
Устанавливает заливку текста на текущий запуск текста.
METHOD SetUnderline
Указывает, что содержимое серии отображается вместе со строкой, расположенной непосредственно под символом (меньше, чем все интервалы над и под символами в строке).
METHOD SetVertAlign
Определяет выравнивание, которое будет применяться к содержимому прогона по отношению к стандартному виду текста прогона.
METHOD ToJSON
Преобразует объект ApiTextPr в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTextPr = oDocument.GetDefaultTextPr();
oTextPr.SetFontSize(30);
oTextPr.SetBold(true);
oTextPr.SetCaps(true);
oTextPr.SetColor(255, 111, 61, false);
oTextPr.SetDoubleStrikeout(true);
oTextPr.SetFontFamily("Comic Sans MS");
oTextPr.SetHighlight(128, 128, 128, false);
oTextPr.SetItalic(true);
oTextPr.SetSpacing(80);
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("This is a sample text to show the specified text properties.");
var sClassType = oTextPr.GetClassType();
oParagraph.AddLineBreak();
oParagraph.AddText("Class Type = " + sClassType);
builder.SaveFile("docx", "ApiTextPr.docx");
builder.CloseFile();CLASS ApiUniColor
new ApiUniColor()
Класс, представляющий базовый класс для типов цвета.
Методы
METHOD GetClassType
Возвращает тип класса ApiUniColor.
METHOD ToJSON
Преобразует объект ApiUniColor в объект JSON.
Пример использования
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oPresetColor = Api.CreatePresetColor("peachPuff");
var oGs1 = Api.CreateGradientStop(oPresetColor, 0);
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 111, 61), 100000);
var oFill = Api.CreateRadialGradientFill([oGs1, oGs2]);
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oDrawing = Api.CreateShape("rect", 5930900, 395605, oFill, oStroke);
oParagraph.AddDrawing(oDrawing);
var sClassType = oPresetColor.GetClassType();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Class Type = " + sClassType);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiUniColor.docx");
builder.CloseFile();CLASS ApiUnsupported
new ApiUnsupported()
Класс, представляющий неподдерживаемый элемент.
Методы
METHOD GetClassType
Возвращает тип класса ApiUnsupported.
Ссылка скопирована в буфер обмена