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()Удаляет поле из документа. Возвращает узел сразу после поля. Если конец поля — последний child его родительского узла, возвращает его родительский абзац. Если поле уже удалено, возвращаетнулевой .
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");

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