Component Studio
Component Studio is the interface for creating, editing, testing, or deleting the components in your HotDocs Templates.
You can open and close Component Studio as needed, or you can display it and switch between your template and Component Studio as you work. Keeping both windows open makes it easier to view and edit all the components in your template at once.
The individual component editors described in this, and subsequent reference topics can also be accessed from the HotDocs Field Editor in the form of pop-up component editors. You should be aware, however, that if you previously opened Component Studio from Workspace Explorer you cannot edit any components in that file using the pop-up component editors from within the Field Editor. While you can open the editors, they present a read-only version of the component. If you want to work with these editors, you must first close the version of Component Studio you opened from the Workspace Explorer. If you first open Component Studio from your word processor, you do not have this restriction.
You can open Component Studio from the following locations:
* The HotDocs Author Tab on the ribbon (by clicking Component Studio)
* The HotDocs Test Browser (by right-clicking a component and selecting Edit Component.)
Common Tasks
Among others, the Component Studio enables you to perform the following common tasks:
- Creating a Text variable
- Creating a Number variable
- Creating a Date variable
- Creating a True/False variable
- Creating a Single Select variable
- Creating a Multi Select variable
- Creating a Dialog
- Creating a Computation
Keyboard Shortcuts
Component Studio's interface includes keyboard shortcuts to enable you to work more rapidly than you can by clicking with a mouse.
Window Title
The title of the Component Studio window carries the name of the currently opened component file. If you see [Read-Only] after the title and a lock icon on the component editor's tabs, you have a read-only copy of the component file open and you cannot make any edits.
Component files may be read-only if you are using a source control system for versioning your template and component files.
Component Studio Ribbon
The top of the Component Studio window displays a ribbon containing the following buttons:
Button | What it Does |
Save | Saves any changes you make to a component. |
Undo/Redo | Enables you to undo and redo the changes you make in Component Studio.
When you use the Undo and Redo buttons to undo or redo changes in the Component File Properties Dialog, a notification appears next to the Properties button. |
New | Enables you to create new components. When you select a component from the drop-down list a dialog appears where you can enter the basic details of the new component. The editor for that component type then opens. |
Find | Opens the Find in Components dialog box to enable you search for text strings in components. |
Properties | Opens the Component File Properties dialog box to enable you to edit component file level properties. |
Help | Launches the help documentation for HotDocs Author. |
Find in Components Dialog Box
When you click Find at the top of Component Studio, the Find in Components dialog box enables you to search through all the components in the component file for text strings, then returns results in the Find Results pane at the bottom of Component Studio:
Element | What it Does |
Find what | Enables you to type the text string for which you want to search. |
Find options | Enables you to specify whether you want to constrain you search by one or both of the following:
|
Look in | Enables you to specify whether you want to constrain you search by one or more of the following:
|
Component File Properties Dialog Box
To access component file preferences, click the Properties button at the top of the component studio.
Property | What it Does |
Maximum WHILE iterations | To prevent HotDocs from infinitely processing a WHILE expression, which causes HotDocs to stop responding, type a number in this field. This number represents the number of times dialogs or variables in the template or script can be looped before HotDocs stops it from doing so. |
Maximum processing stack depth | To prevent HotDocs from infinitely processing (or recursing) a computation, which causes HotDocs to stop responding, type a number in this field. This number represents how many instructions you want HotDocs to allow in the processing stack. When HotDocs reaches this limit, the recursion will stop. |
Main Components List
The main components list displays components in the current component file and enables you to search, sort, and filter the contents of the component file.
Right-click on a component in this list to view a quick actions menu that enables you to: Edit, Rename, Duplicate, Cut, Copy, Paste, or Delete a component.
Element | What it Does |
Search box | Enables you to quickly locate components within the component file. As you type, search results display immediately. You can clear the search box by clicking X. |
Filter (All components) drop-down list |
The following options filter your search results (you can only search within this component file): All components – displays all components (excluding supplemental components)
|
Sort (drop-down arrow) |
Enables you to sort the component file's components. You can choose between the following sort options:
|
Select multiple | Enables you to select more than one component in the main components list. When you select more than one component, the multiple component editor opens in the right pane, which enables you to:
You can also use keyboard shortcuts to select multiple components in the contents pane. |
Create |
Enables you to create a component depending on the type you select in the drop-down list. If you set the Filter (All Components) on the left to a given type, the create button displays and creates this type when you click the create button. |
Component list |
Displays the contents of the component file according to search parameters, sorting, and any filters or multiple selection you apply. Select a component from the list to view it in the right pane, or double-click a component to pin it open for editing. |
Component Editors and Tools
The right side of Component Studio is where you can create and edit the individual components of your component file. If you plan your templates before creating them, you can have a good idea of which components you need for a template before you even create your template. This enables you to create most of your components at once and then insert them into the template as needed. Still, you may find that you need to create or edit new components while you are working on your templates.
Each component you edit or create opens in its own tab in the editor area of Component Studio. This enables you to work with various components at the same time. Each type of component has its own editor to provide access to the different properties available with that type of component. When you edit the properties, you change how that component behaves during the interview, and how HotDocs assembles the final document.
You can use the following component editors:
- Variable Editors
- Dialog Editor
- Computation Editor
- Dialog Element Editors
Tab Behavior
As you open components for editing, a tab for the component will display at the top of the editor. Once a tab is open, you can interact with the following elements:
Element | What it Does |
Component editor tab | Displays both the component type icon and the component in a visual tab. This tab feature enables you to perform the following actions:
If you have a component open in another window when you close Component Studio, the next time you open Component Studio for this template that component is no longer open in a separate window. |
Component editor tab right-click menu | You can right-click on a tab to open a menu with the following options:
|
Open tab group | Displays the tabs for any components that has been opened from the main component list via double-click. The open tab group is located at the upper-leftmost position of the editor and can contain as many tabs as you desire. |
"Quick access" tab | Displays the tab for any component that has been opened from the main component list via single-click. The "quick access" tab is located at the upper-rightmost position of the editor and can only contain a single tab. For example, if you single-click to open another component, the "quick access" tab will display the newly selected component (no longer displaying the editor of the previous selection).
The purpose of the "quick access" tab is to help keep your tabs organized and to provide you a quick way to make an edit to a component without cluttering your tab groups. For example, you can review the contents of a component editor before deciding to either close or keep the tab open. You can click the Keep Tab Open button on the "quick access" tab to move the tab to the open tab group to the left. There are also other commands available to you in the right-click menu you access by right-clicking anywhere on the tab. |
Find Results Pane
The Find Results pane is docked at the bottom left of Component Studio and displays the results of the text string searches of the Find in Components feature:
Element | What it Does |
Find Results title bar | Displays the parameters of your search in single quotes followed by (in parentheses) the number of components returned by the search. |
List of components | Enables you to click a component name or icon to open a component, and (if appropriate) opens the pane containing the text string you searched for. |
(right-click menu) X | Clears the find in component results. |
Errors Pane
The Errors pane is docked at the bottom left of Component Studio. If there are errors within any components, the title of the errors pane displays the number of errors (as in Errors (8)). In addition, a small red icon appears in front of the title to alert you to the presence of errors in your component file. Clicking the error text takes you to the location of the error.
The error list appears as follows:
Element | What it Does |
Name of components |
Enables you to click to open the component which contains an error. |
Error description |
Details the nature of the error. |