Assembly.AddCustomInterviewButton Method
This method was deprecated in HotDocs Server 11. The functionality is now available in the Javascript API.
This method adds a custom button to the interview toolbar. When a user clicks the button, JavaScript code is executed to perform any action you may wish to make available to users of your host application, such as displaying your host application's help file.
Custom buttons are always added to the left of the existing toolbar buttons in the order in which they are added.
You can also add custom buttons to the toolbar on the client side using the HDAPI.AddCustomToolbarButton in the JavaScript API, which also gives you the option of making your button active or inactive.
Syntax
public int AddCustomInterviewButton ( string imageUrl , string hotImageUrl , string toolTip , string statusText , string javascript )
| Parameter | Description |
| imageUrl | The URL of an image to use for the custom toolbar button. |
| hotImageUrl | The URL of an image to use for the custom toolbar button when the user hovers the mouse over it. |
| toolTip | The text to display as a tooltip when the user hovers the mouse over the button. |
| statusText | The text to display in the status bar when the user hovers the mouse over the button. |
| javascript | A block of JavaScript code that will be executed when the user clicks the button.
You can declare a function (or import it into) the page in which the HotDocs Server interview is embedded, and then specify that function like this: MyFunction(); |
Return Value
The new button's index, which you can later use to remove the button (see RemoveCustomInterviewButton).
Example
// This example adds a custom button to the interview toolbar.
HotDocs.Server.Assembly asm = _session.Assemblies.AddNew();
int myButton = asm.AddCustomInterviewButton("MyButton.gif","MyButtonHot.gif","Tooltip","Status Text","alert('Hello World!');");
//To remove the button later, use this code:
asm.RemoveCustomInterviewButton(myButton);