Продукты Р7
Корпоративный сервер 2024
Корпоративный сервер 2024
Сервер документов
Сервер документов
Редакторы
Редакторы
Корпоративный сервер 2019
Корпоративный сервер 2019
Графика
Графика
Команда
Команда
Мобильные редакторы
Мобильные редакторы
Облачный офис
Облачный офис
Почта
Почта
Органайзер
Органайзер
Дополнительно
Часто задаваемые вопросы
Разработчикам
Интеграции
Новые возможности

Справочник методов класса ApiTextPr текстового документа

Обновлено: 15.12.25

new ApiTextPr()

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

Методы

Название Описание
GetClassType ↗ Возвращает тип класса ApiTextPr.
SetBold ↗ Устанавливает свойство полужирного шрифта для текстового символа.
SetCaps ↗ Указывает, что любые символы нижнего регистра в текстовом фрагменте форматируются для отображения только как эквиваленты символов заглавных букв.
SetColor ↗ Устанавливает цвет текста для текущего текста в формате RGB.
SetDoubleStrikeout ↗ Указывает, что содержимое прогона отображается в виде двух горизонтальных линий, пересекающих каждый символ, отображаемый в строке.
SetFill ↗ Устанавливает цвет текста для текущего текста.
SetFontFamily ↗ Устанавливает все 4 слота шрифтов с указанным семейством шрифтов.
SetFontSize ↗ Устанавливает размер шрифта в соответствии с символами текущего текста.
SetHighlight ↗ Указывает цвет выделения, который добавляется к свойствам текста и применяется в качестве фона к содержимому текущего фрагмента/диапазона/абзаца.
SetItalic ↗ Устанавливает свойство курсива для текстового символа.
SetLanguage ↗ Указывает языки, которые будут использоваться для проверки орфографии и грамматики (если требуется) при обработке содержимого прогона текста.
SetOutLine ↗ Устанавливает структуру текста для текущего фрагмента текста.
SetPosition ↗ Указывает величину, на которую текст поднимается или опускается для этого прогона относительно базовой линии по умолчанию для окружающего непозиционированного текста.
SetShd ↗ Указывает затенение, применяемое к содержимому текущего фрагмента текста.
SetSmallCaps ↗ Указывает, что все символы строчных букв в текстовом фрагменте форматируются для отображения только как эквиваленты символов заглавных букв, которые на два пункта меньше фактического размера шрифта, указанного для этого текста.
SetSpacing ↗ Устанавливает интервал между текстом, измеряемый в двадцатых долях точки.
SetStrikeout ↗ Указывает, что содержимое выполнения отображается одной горизонтальной линией, проходящей через центр линии.
SetStyle ↗ Базовый метод текстового стиля.
Этот метод не используется сам по себе, поскольку он лишь формирует основу для метода ApiRun#SetStyle ↗, который устанавливает выбранный или созданный стиль для текста.
SetTextFill ↗ Устанавливает заливку текста для текущего фрагмента текста.
SetUnderline ↗ Указывает, что содержимое серии отображается вместе со строкой, расположенной непосредственно под символом (меньше, чем все пробелы над и под символами в строке).
SetVertAlign ↗ Указывает выравнивание, которое будет применено к содержимому прогона относительно внешнего вида текста прогона по умолчанию:

  • «базовая линия» — символы в текущем текстовом фрагменте будут выровнены по базовой линии текста по умолчанию.
  • «нижний индекс» — символы в текущем текстовом фрагменте будут выровнены ниже базовой линии текста по умолчанию.
  • «надстрочный индекс» — символы в текущем текстовом фрагменте будут выровнены над базовой линией текста по умолчанию.
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();