FieldIncludeText

FieldIncludeText class

Implementerar INCLUDETEXT-fältet.

För att lära dig mer, besökArbeta med fält dokumentationsartikel.

public class FieldIncludeText : Field

Konstruktörer

namnBeskrivning
FieldIncludeText()Default_Constructor

Egenskaper

namnBeskrivning
BookmarkName { get; set; }Hämtar eller ställer in namnet på bokmärket i dokumentet som ska inkluderas.
DisplayResult { get; }Hämtar texten som representerar det visade fältresultatet.
Encoding { get; set; }Hämtar eller ställer in kodningen som tillämpas på data i den refererade filen.
End { get; }Hämtar noden som representerar fältets slut.
Format { get; }Får enFieldFormatobjekt som ger typad åtkomst till fältets formatering.
IsDirty { get; set; }Hämtar eller anger om det aktuella resultatet av fältet inte längre är korrekt (inaktuellt) på grund av andra ändringar som gjorts i dokumentet.
IsLocked { get; set; }Hämtar eller anger om fältet är låst (resultatet ska inte beräknas om).
LocaleId { get; set; }Hämtar eller ställer in fältets LCID.
LockFields { get; set; }Hämtar eller anger om fält i det inkluderade dokumentet ska förhindras från att uppdateras.
MimeType { get; set; }Hämtar eller ställer in MIME-typen för den refererade filen.
NamespaceMappings { get; set; }Hämtar eller ställer in namnrymdsmappningar för XPath-frågor.
Result { get; set; }Hämtar eller anger text som är mellan fältavgränsaren och fältslutet.
Separator { get; }Hämtar noden som representerar fältseparatorn. Kan varanull .
SourceFullName { get; set; }Hämtar eller anger dokumentets plats med hjälp av en IRI.
Start { get; }Hämtar noden som representerar början av fältet.
TextConverter { get; set; }Hämtar eller anger namnet på textkonverteraren för formatet för den inkluderade filen.
virtual Type { get; }Hämtar fälttypen Microsoft Word.
XPath { get; set; }Hämtar eller ställer in XPath för önskad del av XML-filen.
XslTransformation { get; set; }Hämtar eller anger platsen för XSL-transformationen för att formatera XML-data.

Metoder

namnBeskrivning
GetFieldCode()Returnerar text mellan fältstart och fältavgränsare (eller fältslut om det inte finns någon avgränsare). Både fältkod och fältresultat för underfält inkluderas.
GetFieldCode(bool)Returnerar text mellan fältstart och fältavgränsare (eller fältslut om det inte finns någon avgränsare).
Remove()Tar bort fältet från dokumentet. Returnerar en nod direkt efter fältet. Om fältets slut är den sista undernoden till dess överordnade nod, returneras dess överordnade stycke. Om fältet redan är borttaget returnerasnull .
Unlink()Utför fältavkopplingen.
Update()Utför fältuppdateringen. Körs om fältet redan uppdateras.
Update(bool)Utför en fältuppdatering. Körs om fältet redan uppdateras.

Anmärkningar

Infogar hela eller delar av texten och bilderna som finns i ett annat dokument.

Exempel

Visar hur man skapar ett INCLUDETEXT-fält och anger dess egenskaper.

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

    // Nedan följer två sätt att använda INCLUDETEXT-fält för att visa innehållet i en XML-fil i det lokala filsystemet.
    // 1 - Utför en XSL-transformation på ett XML-dokument:
    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 - Använd en XPath för att hämta specifika element från ett XML-dokument:
    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>
/// Använd en dokumentbyggare för att infoga ett INCLUDETEXT-fält med anpassade egenskaper.
/// </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;
}

Se även