FieldIncludeText

FieldIncludeText class

Implementerar fältet INCLUDETEXT.

public class FieldIncludeText : Field

Konstruktörer

namn Beskrivning
FieldIncludeText() Default_Constructor

Egenskaper

namn Beskrivning
BookmarkName { get; set; } Hämtar eller ställer in namnet på bokmärket i dokumentet för att inkludera.
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ältänden.
Format { get; } Får enFieldFormat objekt som ger maskinskriven åtkomst till fältets formatering.
IsDirty { get; set; } Hämtar eller ställer in 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 ställer in om fältet är låst (ska inte räkna om resultatet).
LocaleId { get; set; } Hämtar eller ställer in LCID för fältet.
LockFields { get; set; } Hämtar eller ställer in 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 namnområdesmappningar för XPath-frågor.
Result { get; set; } Hämtar eller ställer in text som är mellan fältavgränsaren och fältslutet.
Separator { get; } Hämtar noden som representerar fältseparatorn. Kan vara null.
SourceFullName { get; set; } Hämtar eller ställer in platsen för dokumentet med en IRI.
Start { get; } Hämtar noden som representerar början av fältet.
TextConverter { get; set; } Hämtar eller ställer in namnet på textkonverteraren för formatet på 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 ställer in platsen för XSL Transformation för att formatera XML-data.

Metoder

namn Beskrivning
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 underordnade fält ingår.
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 child av dess överordnade nod, returnerar dess överordnade stycke. Om fältet redan är borttaget, returneras null .
Unlink() Utför fältavlänkningen.
Update() Utför fältuppdateringen. Kastar om fältet redan uppdateras.
Update(bool) Utför en fältuppdatering. Kastar om fältet redan uppdateras.

Anmärkningar

Infogar hela eller delar av texten och grafiken i ett annat dokument.

Exempel

Visar hur man skapar ett INCLUDETEXT-fält och ställer in dess egenskaper.

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

    // Nedan finns 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 ta 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.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