Component.Prompt Property

[Read-only] This is a string property that tells the prompt of the variable.

Syntax

string Prompt [ get ]

Example

The following Visual C# example displays information about each of the variable components in a given component file:

public class ExampleCode
{
    static void Main()
    {
        HotDocs.ComponentCollection ccl = new HotDocs.ComponentCollection();
         
        ccl.Open(@"C:\Documents\HotDocs\Templates\demoempl.cmp");
         
        HotDocs.HDVARTYPE varType = HotDocs.HDVARTYPE.HD_TEXTTYPE;
        HotDocs.Component comp;
         
        for (int i=0; i < ccl.Count; i++)
        {
            comp = ccl.Item(i, ref varType) as HotDocs.Component;
             
            Console.WriteLine("Name: {0}",comp.Name);
            Console.WriteLine("Type: {0}", comp.Type);
            Console.WriteLine("Title:{0}", comp.Title);
            Console.WriteLine("Prompt: {0}", comp.Prompt);
            Console.WriteLine("Help Text: {0}", comp.HelpText);
            Console.WriteLine("Dialog Name: {0}", comp.DialogName);
            Console.WriteLine("Database Name: {0}", comp.DBName);
            Console.WriteLine();
        }
        Console.ReadKey();
    }
}