Component.Prompt Property

[Read-only] This string property returns the prompt of the component.

Syntax

public string Prompt { get; }

Example

// This example displays information about each Text variable in a given component file. public class ExampleCode
{
    static void Main()
    {
        HotDocs.Server.ComponentCollection ccl = new HotDocs.Server.ComponentCollection();
        HotDocs.Server.Component cmp;
        ccl.Open("c:\\temp\\demoempl.cmp",HotDocs.Server.Interop.CMPOpenOptions.LoadAllCompLibs);
        for (int i = 0; i < ccl.Count; i++)
        {
            cmp = (HotDocs.Server.Component)ccl[i];
         
            if (cmp.Type == HotDocs.Server.Interop.hdCmpType.hdTextType)
            {
                MessageBox.Show("Name: " + cmp.Name + "\r\nPrompt: " + cmp.Prompt);
            }
        }
    }
}