FieldAutoTextList

FieldAutoTextList class

Implementerar fältet AUTOTEXTLIST.

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

public class FieldAutoTextList : Field

Konstruktörer

namnBeskrivning
FieldAutoTextList()Default_Constructor

Egenskaper

namnBeskrivning
DisplayResult { get; }Hämtar texten som representerar det visade fältresultatet.
End { get; }Hämtar noden som representerar fältets slut.
EntryName { get; set; }Hämtar eller anger namnet på AutoText-posten.
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).
ListStyle { get; set; }Hämtar eller anger namnet på den stil som listan som ska innehålla poster baseras på.
LocaleId { get; set; }Hämtar eller ställer in fältets LCID.
Result { get; set; }Hämtar eller anger text som är mellan fältavgränsaren och fältslutet.
ScreenTip { get; set; }Hämtar eller ställer in texten i skärmtipset som ska visas.
Separator { get; }Hämtar noden som representerar fältseparatorn. Kan varanull .
Start { get; }Hämtar noden som representerar början av fältet.
virtual Type { get; }Hämtar fälttypen Microsoft Word.

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

Skapar en snabbmeny baserad på AutoText-poster i den aktiva mallen.

Exempel

Visar hur man använder ett AUTOTEXTLIST-fält för att välja från en lista med AutoText-poster.

public void FieldAutoTextList()
{
    Document doc = new Document();

    // Skapa ett ordlistadokument och fyll det med automatiska textinmatningar.
    doc.GlossaryDocument = new GlossaryDocument();
    AppendAutoTextEntry(doc.GlossaryDocument, "AutoText 1", "Contents of AutoText 1");
    AppendAutoTextEntry(doc.GlossaryDocument, "AutoText 2", "Contents of AutoText 2");
    AppendAutoTextEntry(doc.GlossaryDocument, "AutoText 3", "Contents of AutoText 3");

    DocumentBuilder builder = new DocumentBuilder(doc);

    // Skapa ett AUTOTEXTLIST-fält och ange texten som fältet ska visa i Microsoft Word.
    // Ställ in texten så att användaren högerklickar på det här fältet för att välja ett AutoText-byggblock,
    // vars innehåll fältet kommer att visa.
    FieldAutoTextList field = (FieldAutoTextList)builder.InsertField(FieldType.FieldAutoTextList, true);
    field.EntryName = "Right click here to select an AutoText block";
    field.ListStyle = "Heading 1";
    field.ScreenTip = "Hover tip text for AutoTextList goes here";

    Assert.AreEqual(" AUTOTEXTLIST  \"Right click here to select an AutoText block\" " +
                    "\\s \"Heading 1\" " +
                    "\\t \"Hover tip text for AutoTextList goes here\"", field.GetFieldCode());

    doc.Save(ArtifactsDir + "Field.AUTOTEXTLIST.dotx");
}

/// <summary>
/// Skapa ett byggblock av AutoText-typ och lägg till det i ett ordlistadokument.
/// </summary>
private static void AppendAutoTextEntry(GlossaryDocument glossaryDoc, string name, string contents)
{
    BuildingBlock buildingBlock = new BuildingBlock(glossaryDoc);
    buildingBlock.Name = name;
    buildingBlock.Gallery = BuildingBlockGallery.AutoText;
    buildingBlock.Category = "General";
    buildingBlock.Behavior = BuildingBlockBehavior.Paragraph;

    Section section = new Section(glossaryDoc);
    section.AppendChild(new Body(glossaryDoc));
    section.Body.AppendParagraph(contents);
    buildingBlock.AppendChild(section);

    glossaryDoc.AppendChild(buildingBlock);
}

Se även

FieldAutoText Class FieldBarcode Class