FieldCitation

FieldCitation class

Реализует поле ЦИТАТА.

public class FieldCitation : Field

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

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

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

Имя Описание
AnotherSourceTag { get; set; } Получает или задает значение, соответствующее Ярлык значение элемента другого источника для включения в цитату.
DisplayResult { get; } Получает текст, представляющий результат отображаемого поля.
End { get; } Получает узел, представляющий конец поля.
Format { get; } ПолучаетFieldFormat объект, предоставляющий типизированный доступ к форматированию поля.
FormatLanguageId { get; set; } Получает или задает идентификатор языка, который используется в сочетании с указанным библиографическим стилем для форматирования citation в документе.
IsDirty { get; set; } Получает или устанавливает, является ли текущий результат поля более неверным (устаревшим) из-за других изменений, внесенных в документ.
IsLocked { get; set; } Получает или задает, заблокировано ли поле (не следует пересчитывать его результат).
LocaleId { get; set; } Получает или задает LCID поля.
PageNumber { get; set; } Получает или задает номер страницы, связанный с цитатой.
Prefix { get; set; } Получает или задает префикс, который добавляется к цитате.
Result { get; set; } Получает или задает текст, который находится между разделителем поля и концом поля.
Separator { get; } Получает узел, представляющий разделитель полей. Может быть нулевым.
SourceTag { get; set; } Получает или задает значение, соответствующее Ярлыкзначение элемента источника для вставки.
Start { get; } Получает узел, представляющий начало поля.
Suffix { get; set; } Получает или задает суффикс, который добавляется к цитате.
SuppressAuthor { get; set; } Получает или задает, скрыта ли информация об авторе из цитирования.
SuppressTitle { get; set; } Получает или задает, скрыта ли информация о заголовке из цитирования.
SuppressYear { get; set; } Получает или задает, будет ли информация о годе скрыта из цитирования.
virtual Type { get; } Получает тип поля Microsoft Word.
VolumeNumber { get; set; } Получает или задает номер тома, связанный с цитатой.

Методы

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

Примечания

Вставляет содержимое Источник элемент с указанным Ярлык элемент, использующий библиографический стиль.

Примеры

Показывает, как работать с полями ЦИТАЦИЯ и БИБЛИОГРАФИЯ.

// Открываем документ, содержащий библиографические источники, которые мы можем найти в
// Microsoft Word через ссылки -> Цитаты и ссылки Библиография -> Управление источниками.
Document doc = new Document(MyDir + "Bibliography.docx");
DocumentBuilder builder = new DocumentBuilder(doc);
builder.Write("Text to be cited with one source.");

// Создать цитату, указав только номер страницы и автора книги, на которую ссылаются.
FieldCitation fieldCitation = (FieldCitation)builder.InsertField(FieldType.FieldCitation, true);

// Мы ссылаемся на источники, используя имена их тегов.
fieldCitation.SourceTag = "Book1";
fieldCitation.PageNumber = "85";
fieldCitation.SuppressAuthor = false;
fieldCitation.SuppressTitle = true;
fieldCitation.SuppressYear = true;

Assert.AreEqual(" CITATION  Book1 \\p 85 \\t \\y", fieldCitation.GetFieldCode());

// Создать более подробную цитату со ссылкой на два источника.
builder.InsertParagraph();
builder.Write("Text to be cited with two sources.");
fieldCitation = (FieldCitation)builder.InsertField(FieldType.FieldCitation, true);
fieldCitation.SourceTag = "Book1";
fieldCitation.AnotherSourceTag = "Book2";
fieldCitation.FormatLanguageId = "en-US";
fieldCitation.PageNumber = "19";
fieldCitation.Prefix = "Prefix ";
fieldCitation.Suffix = " Suffix";
fieldCitation.SuppressAuthor = false;
fieldCitation.SuppressTitle = false;
fieldCitation.SuppressYear = false;
fieldCitation.VolumeNumber = "VII";

Assert.AreEqual(" CITATION  Book1 \\m Book2 \\l en-US \\p 19 \\f \"Prefix \" \\s \" Suffix\" \\v VII", fieldCitation.GetFieldCode());

// Мы можем использовать поле БИБЛИОГРАФИЯ для отображения всех источников в документе.
builder.InsertBreak(BreakType.PageBreak);
FieldBibliography fieldBibliography = (FieldBibliography)builder.InsertField(FieldType.FieldBibliography, true);
fieldBibliography.FormatLanguageId = "1124";

Assert.AreEqual(" BIBLIOGRAPHY  \\l 1124", fieldBibliography.GetFieldCode());

doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.CITATION.docx");

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