FieldAutoNum

FieldAutoNum class

Реализует поле AUTONUM.

Чтобы узнать больше, посетитеРабота с полями статья документации.

public class FieldAutoNum : Field

Конструкторы

ИмяОписание
FieldAutoNum()Конструктор по умолчанию.

Характеристики

ИмяОписание
DisplayResult { get; }Получает текст, представляющий результат отображаемого поля.
End { get; }Получает узел, представляющий конец поля.
Format { get; }ПолучаетFieldFormat объект, обеспечивающий типизированный доступ к форматированию поля.
IsDirty { get; set; }Получает или устанавливает, является ли текущий результат поля более неправильным (устаревшим) из-за других изменений, внесенных в документ.
IsLocked { get; set; }Получает или задает, заблокировано ли поле (не следует пересчитывать результат).
LocaleId { get; set; }Получает или задает LCID поля.
Result { get; set; }Получает или задает текст, расположенный между разделителем полей и концом поля.
Separator { get; }Получает узел, представляющий разделитель полей. Возможнонулевой .
SeparatorCharacter { get; set; }Получает или задает используемый символ-разделитель.
Start { get; }Получает узел, представляющий начало поля.
virtual Type { get; }Получает тип поля Microsoft Word.

Методы

ИмяОписание
GetFieldCode()Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет). Включены как код поля, так и результат поля дочерних полей.
GetFieldCode(bool)Возвращает текст между началом поля и разделителем полей (или концом поля, если разделителя нет).
Remove()Удаляет поле из документа. Возвращает узел сразу после поля. Если конец поля является последним дочерним его родительского узла, возвращает его родительский абзац. Если поле уже удалено, возвращаетсянулевой .
Unlink()Выполняет отсоединение поля.
Update()Выполняет обновление поля. Выдает, если поле уже обновляется.
Update(bool)Выполняет обновление поля. Выдает, если поле уже обновляется.

Примечания

Вставляет автоматический номер.

Примеры

Показывает, как нумеровать абзацы с помощью полей автонумерации.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// В каждом поле AUTONUM отображается текущее значение счетчика полей AUTONUM,
// что позволяет нам автоматически нумеровать элементы, как в нумерованном списке.
// В этом поле будет отображаться число «1».
FieldAutoNum field = (FieldAutoNum)builder.InsertField(FieldType.FieldAutoNum, true);
builder.Writeln("\tParagraph 1.");

Assert.AreEqual(" AUTONUM ", field.GetFieldCode());

field = (FieldAutoNum)builder.InsertField(FieldType.FieldAutoNum, true);
builder.Writeln("\tParagraph 2.");

// Символ-разделитель, который появляется в результате поля сразу после числа, по умолчанию является точкой.
// Если мы оставим это свойство нулевым, наше второе поле AUTONUM отобразит «2». в документе.
Assert.IsNull(field.SeparatorCharacter);

// Мы можем установить это свойство, чтобы применить первый символ строки в качестве нового символа-разделителя.
// В этом случае наше поле AUTONUM теперь будет отображать «2:».
field.SeparatorCharacter = ":";

Assert.AreEqual(" AUTONUM  \\s :", field.GetFieldCode());

doc.Save(ArtifactsDir + "Field.AUTONUM.docx");

Смотрите также

FieldAuthor Class FieldAutoNumLgl Class