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

  • Post category:ApiNumberingLevel
  • Запись изменена:10.12.2023
Print Friendly, PDF & EmailРаспечатать/сохранить в PDF

new ApiNumberingLevel()

Класс, представляющий ссылку на определенный уровень нумерации.

Методы

НазваниеОписание
GetClassTypeВозвращает тип класса ApiNumberingLevel.
GetLevelIndexВозвращает индекс уровней.
GetNumberingВозвращает определение нумерации.
GetParaPrВозвращает свойства абзаца, которые применяются к любому пронумерованному абзацу, который ссылается на данное определение нумерации и уровень нумерации.
GetTextPrУказывает свойства текста, которые будут применяться к тексту на текущем уровне нумерации, а не к тексту в последующем абзаце. Чтобы изменить стиль текста в абзаце, к нему необходимо применить стиль с помощью метода ApiRun.SetStyle.
SetCustomTypeЗадает собственный тип нумерации.
SetRestartЗадает индекс с отсчетом от единицы, который определяет, когда уровень нумерации должен перезапуститься до своего стартового значения. Уровень нумерации перезапускается, когда экземпляр указанного уровня нумерации, который выше (ранее, чем этот уровень), используется в данном содержании документа. По умолчанию это значение истинно.
SetStartЗадает начальное значение для нумерации, используемой родительским уровнем нумерации в заданном определении уровня нумерации. По умолчанию это значение равно 1.
SetSuffУказывает содержимое, которое будет добавлено между текстом данного уровня нумерации и текстом каждого пронумерованного абзаца, который ссылается на этот уровень нумерации. По умолчанию это значение «вкладка».
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();