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; }获取或设置 XML 文件所需部分的 XPath。
XslTransformation { get; set; }获取或设置用于格式化 XML 数据的 XSL 转换的位置。

方法

姓名描述
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 - 对 XML 文档执行 XSL 转换：
    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