FieldIncludeText

FieldIncludeText class

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

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

public class FieldIncludeText : Field

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

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

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

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

Методы

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

Примечания

Вставляет весь или часть текста и графики, содержащихся в другом документе.

Примеры

Показывает, как создать поле INCLUDETEXT и задать его свойства.

public void FieldIncludeText()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    // Ниже приведены два способа использования полей INCLUDETEXT для отображения содержимого XML-файла в локальной файловой системе.
    // 1 — Выполнить XSL-преобразование XML-документа:
    FieldIncludeText fieldIncludeText = CreateFieldIncludeText(builder, MyDir + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
    fieldIncludeText.XslTransformation = MyDir + "CD collection XSL transformation.xsl";

    builder.Writeln();

    // 2 — Используйте XPath для извлечения определенных элементов из XML-документа:
    fieldIncludeText = CreateFieldIncludeText(builder, MyDir + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
    fieldIncludeText.NamespaceMappings = "xmlns:n='myNamespace'";
    fieldIncludeText.XPath = "/catalog/cd/title";

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

/// <summary>
/// Используйте конструктор документов для вставки поля INCLUDETEXT с пользовательскими свойствами.
/// </summary>
public FieldIncludeText CreateFieldIncludeText(DocumentBuilder builder, string sourceFullName, bool lockFields, string mimeType, string textConverter, string encoding)
{
    FieldIncludeText fieldIncludeText = (FieldIncludeText)builder.InsertField(FieldType.FieldIncludeText, true);
    fieldIncludeText.SourceFullName = sourceFullName;
    fieldIncludeText.LockFields = lockFields;
    fieldIncludeText.MimeType = mimeType;
    fieldIncludeText.TextConverter = textConverter;
    fieldIncludeText.Encoding = encoding;

    return fieldIncludeText;
}

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

FieldIncludePicture Class FieldIndex Class