FieldComments

FieldComments class

Реализует поле КОММЕНТАРИИ.

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

public class FieldComments : Field

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

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

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

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

Методы

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

Примечания

Извлекает и, при необходимости, устанавливает комментарии, относящиеся к текущему документу, как записано вComments property встроенных свойств документа.

Примеры

Показывает, как использовать поле КОММЕНТАРИИ.

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

// Устанавливаем значение для встроенного свойства документа «Комментарии».
doc.BuiltInDocumentProperties.Comments = "My comment.";

// Создайте поле КОММЕНТАРИЙ для отображения значения этого встроенного свойства.
FieldComments field = (FieldComments)builder.InsertField(FieldType.FieldComments, true);
field.Update();

Assert.AreEqual(" COMMENTS ", field.GetFieldCode());
Assert.AreEqual("My comment.", field.Result);

// Если мы зададим значение свойства Text поля COMMENTS и обновим его, поле будет
// перезаписываем текущее значение встроенного свойства «Комментарии» значением его свойства Text,
// и затем отображаем новое значение.
field.Text = "My overriding comment.";
field.Update();

Assert.AreEqual(" COMMENTS  \"My overriding comment.\"", field.GetFieldCode());
Assert.AreEqual("My overriding comment.", field.Result);

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

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

FieldCollection Class FieldCompare Class