ListStyle

FieldAutoTextList.ListStyle property

Gets or sets the name of the style on which the list to contain entries is based.

public string ListStyle { get; set; }

Examples

Shows how to use an AUTOTEXTLIST field to select from a list of AutoText entries.

Document doc = new Document();

// Create a glossary document and populate it with auto text entries.
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);

// Create an AUTOTEXTLIST field and set the text that the field will display in Microsoft Word.
// Set the text to prompt the user to right-click this field to select an AutoText building block,
// whose contents the field will display.
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.That(field.GetFieldCode(), Is.EqualTo(" AUTOTEXTLIST  \"Right click here to select an AutoText block\" " +
                "\\s \"Heading 1\" " +
                "\\t \"Hover tip text for AutoTextList goes here\""));

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

Shows how to use an AUTOTEXTLIST field to select from a list of AutoText entries (AppendAutoTextEntry).

/// <summary>
/// Create an AutoText-type building block and add it to a glossary document.
/// </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);
}

See Also

FieldAutoTextList.EntryName FieldAutoTextList.ScreenTip