HTML Files

 

The latest version of this topic can be found at HTML Files.

A wizard can contain a user interface, which is an HTML interface. Along with Default.htm, a wizard can contain any number of .htm files, which you can indicate in the Number of Pages box in the Custom Wizard. Each .htm file represents an HTML page of your wizard, and the HTML page is accessible using Next and Back buttons, tabs, or any other format you specify in your wizard design.

The HTML contains:

  • The SYMBOL tag, which identifies the default for user-defined options. Symbols are written into the symbol table when the user clicks Finish, such as:
<SYMBOL NAME='HEADER_FILE' VALUE='MyHeader.h' TYPE=text></SYMBOL>  

In the wizard user interface (UI), the text box identified in the symbol table as "HEADER_FILE" contains the default text "MyHeader.h". You can change this value in the wizard UI, and the resulting value is written to the project's symbol table when you click Finish, such as:

<SYMBOL NAME='CHECKBOX1' TYPE=checkbox VALUE=false></SYMBOL>  

In the wizard UI, the check box identified in the symbol table as "CHECKBOX1" is cleared by default. You can select this box in the HTML UI, and the resulting value is written to the symbol table when you click Finish.

Each .htm file records user selections to the symbols table.

  • An include for Common.js, which contains commonly used and helpful JScript functions, and Default.js.

  • References to the project's images to display in the HTML.

  • HTML text and formatting that customize the appearance of the wizard's user interface

  • JScript functions that access the Visual C++ Wizard Object Model to provide customized behavior from within the wizard. These functions are in the HTML page section headed <SCRIPT LANGUAGE='JSCRIPT'>, as shown in the following example.

    Note

    To access the Wizard and Environment Object Models from HTML, prepend the object model item with "window.external."

    function InitDocument(document)  
    {  
       setDirection();  
    
       if (window.external.FindSymbol('DOCUMENT_FIRST_LOAD'))  
       {  
          // This function sets the default symbols based   
          // on the values specified in the SYMBOL tags above  
          //  
          window.external.SetDefaults(document);  
       }  
    
       // Load the document and initialize the controls   
       // with the appropriate symbol values  
       //  
       window.external.Load(document);  
    }  
    

The following is a sample console application wizard:

<SYMBOL NAME='WIZARD_DIALOG_TITLE' TYPE=text VALUE='Console Application Wizard'></SYMBOL>  
  
<SYMBOL NAME='EMPTY_PROJECT' TYPE=checkbox VALUE=false></SYMBOL>  
<SYMBOL NAME='SUPPORT_ATL' TYPE=checkbox VALUE=false></SYMBOL>  
<SYMBOL NAME='SUPPORT_MFC' TYPE=checkbox VALUE=false></SYMBOL>  

See Also

Files Created for Your Wizard
Custom Wizard
Creating a Custom Wizard
Designing a Wizard