new ApiRange(Start, End)

Класс, представляющий непрерывную область в документе. Каждый объект диапазона определяется положением начального и конечного символов.

Параметры:

Название	Тип	Описание
Start	численный	Начальный элемент диапазона в текущем элементе.
End	численный	Конечный элемент диапазона в текущем элементе.

Методы

Название	Описание
AddBookmark	Добавляет закладку в указанный диапазон.
AddHyperlink	Добавляет гиперссылку к указанному диапазону.
AddText	Добавляет текст в указанную позицию.
Delete	Удаляет все содержимое из текущего диапазона.
ExpandTo	Возвращает новый диапазон, который выходит за пределы указанного диапазона в любом направлении и охватывает другой диапазон. Текущий диапазон не изменяется. Выбрасывает ошибку, если два диапазона не имеют объединения.
GetAllParagraphs	Возвращает коллекцию абзацев, которая представляет все абзацы в указанном диапазоне.
GetClassType	Возвращает тип класса ApiRange.
GetParagraph	Возвращает параграф из всех параграфов, которые находятся в диапазоне.
GetText	Возвращает текст из указанного диапазона.
IntersectWith	Возвращает новый диапазон как пересечение текущего диапазона с другим диапазоном. Текущий диапазон не изменяется. Выбрасывает ошибку, если два диапазона не пересекаются или не являются смежными.
Select	Устанавливает выделение в указанном диапазоне.
SetBold	Устанавливает свойство bold для текстового символа.
SetCaps	Указывает, что все символы нижнего регистра в текущем текстовом диапазоне форматируются для отображения только как эквиваленты символов заглавных букв.
SetColor	Устанавливает цвет текста на текущий текстовый диапазон в формате RGB.
SetDoubleStrikeout	Указывает, что содержимое текущего диапазона отображается с двумя горизонтальными линиями через каждый символ, отображаемый в строке.
SetFontFamily	Устанавливает все 4 слота шрифта с указанным семейством шрифтов.
SetFontSize	Устанавливает размер шрифта в символы текущего текстового диапазона.
SetHighlight	Указывает цвет выделения, который применяется в качестве фона к содержимому текущего диапазона.
SetItalic	Устанавливает свойство курсива на текстовый символ.
SetPosition	Определяет величину, на которую текст поднимается или опускается для текущего диапазона относительно базовой линии по умолчанию окружающего непозиционированного текста.
SetShd	Определяет затенение, применяемое к содержимому текущего текстового диапазона.
SetSmallCaps	Указывает, что все символы строчных букв в текущем текстовом диапазоне форматируются для отображения только как эквиваленты символов заглавных букв, которые на два пункта меньше фактического размера шрифта, указанного для данного текста.
SetSpacing	Устанавливает расстояние между текстами, измеряемое в двадцатых долях пункта.
SetStrikeout	Указывает, что содержимое текущего диапазона отображается с одной горизонтальной линией через центр диапазона.
SetStyle	Устанавливает стиль для текущего диапазона.
SetTextPr	Устанавливает свойства текста для текущего диапазона.
SetUnderline	Указывает, что содержимое текущего диапазона отображается вместе со строкой, появляющейся непосредственно под символом (меньше всех интервалов над и под символами в строке).
SetVertAlign	Указывает выравнивание, которое будет применяться к содержимому диапазона по отношению к внешнему виду текста диапазона по умолчанию: "baseline" - символы в текущем текстовом диапазоне будут выровнены по базовой линии текста по умолчанию. "subscript" - символы в текущем текстовом диапазоне будут выровнены ниже базовой линии текста по умолчанию. "superscript" - символы в текущем текстовом диапазоне будут выровнены выше базовой линии текста по умолчанию.
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();

[wbcr_css_snippet id="18802"][wbcr_css_snippet id="21788"]