WD2000: How to Create and Display a Custom Dialog Box (212596)

MORE INFORMATION

Microsoft provides programming examples for illustration only, without warranty either expressed or implied. This includes, but is not limited to, the implied warranties of merchantability or fitness for a particular purpose. This article assumes that you are familiar with the programming language that is being demonstrated and with the tools that are used to create and to debug procedures. Microsoft support engineers can help explain the functionality of a particular procedure, but they will not modify these examples to provide added functionality or construct procedures to meet your specific requirements.

Creating the User Form

The following sample creates a user form with a TextBox control and two CommandButton controls (an "OK" button and a "Cancel" button).

Create the form using the following steps:

1. On the Tools menu, point to Macro and then click Visual Basic Editor.
2. In the Visual Basic project window, click Normal.
   
   By clicking Normal, you make the form available to all documents. To create the user form in a custom template, make sure the template is currently open, and select the template project name instead of Normal. For example, if the custom template name is "My Template," in the Visual Basic project window select TemplateProject(My Template). The user form becomes available only when the custom template is open, available as an add-in, or attached to an open document.
3. On the Insert menu, click UserForm.
4. Click the TextBox control on the Toolbox toolbar, and then click the form.
   
   The TextBox control appears in the default size. Drag a sizing handle to resize the control, or drag the control to move it to a new location.
5. Click the CommandButton control on the Toolbox toolbar, and then click the form.
   
   The CommandButton control appears in the default size. Drag a sizing handle to resize the control, or drag the control to move it to a new location.
   
   Repeat this step to add a second CommandButton control.
6. Select the first CommandButton control, and then click Code on the View menu.
7. In the Code window, type Selection.TypeText TextBox1.Text, so that your code looks like this:

   Private Sub CommandButton1_Click ()
      Selection.TypeText TextBox1.Text
   End sub
   						

   NOTE: When you click this button on the form, the contents of the text box is inserted into the active document at the location of the insertion point.
8. On the View menu, click Object to return to the form.
9. Select the second CommandButton control, and then click Code on the View menu.
10. In the Code window, type End, so that your code looks like this:

    Private Sub CommandButton2_Click ()
       End
    End sub
    						

    When you click this button after you click the first command button, the form is closed. If you click this button instead of the first command button, the form is canceled.
11. On the File menu, click Save Normal.

Displaying the Form

To display the form, switch to Word, and then do the following:

1. On the Tools menu, point to Macro, and then click Macros.
2. In the Macro Name box, type FillInForm and then click Create.
3. In the Code window, type UserForm1.Show, so that your code looks like this:

   Sub FillInForm()
      UserForm1.Show
   End Sub
   						

4. On the File menu, click Save Normal.
5. On the File menu, click Close and Return to Microsoft Word. By running the FillinForm macro, you can now run the macro from Word to display the form.

If you want default text to appear in the text box, create an "initialize" event for the UserForm object. To do this, use the following steps:

1. In the Visual Basic Editor, double-click the form.
2. From the Object list, select UserForm.
3. From the Procedure list, select Initialize.
4. In the Code window, type the following code:

   Private Sub UserForm_Initialize()
      TextBox1.Text = "<default text>"
   End Sub
   						

   where <default text> is the text you want to appear in the text box when the form appears.

For more information about User Forms, in the Visual Basic Editor, click Microsoft Visual Basic Help on the Help menu, type UserForm in the Office Assistant or the Answer Wizard, and then click Search to view the topic.
For more information about how to use the sample code in this article, click the article number below to view the article in the Microsoft Knowledge Base: