FieldIncludeText

FieldIncludeText class

实现 INCLUDETEXT 字段。

public class FieldIncludeText : Field

构造函数

姓名 描述
FieldIncludeText() 默认构造函数。

特性

姓名 描述
BookmarkName { get; set; } 获取或设置要包含的文档中书签的名称。
DisplayResult { get; } 获取表示显示字段结果的文本。
Encoding { get; set; } 获取或设置应用于引用文件中数据的编码。
End { get; } 获取代表字段end的节点。
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; } 获取或设置 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 - 对 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.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;
}

也可以看看