HD$ AddCustomNavButton Method |
This function adds a button to the interview navigation bar. When a user clicks the button, a JavaScript function is called that performs any action users may need to take while navigating through the interview.
JavaScript API: Embedded
Assembly: hotdocs.js Version: 1.0.0.0 (1.0.0.0)
Syntax
JavaScript
function AddCustomNavButton(funcClick, funcEnabled, buttonType, buttonText, tooltip, imageName, navGroup, buttonIndex, separator, callback);
Parameters
- funcClick
- Type: function
A Javascript function that should be called whenever the button is clicked. - funcEnabled
- Type: function
A Javascript function that should be called to determine if the button is enabled or not. It should accept one parameter, which is the ID of the custom navigation button being checked. (Default: null, which means the button will always be enabled) - buttonType
- Type: System
Int32
The type of button to create:- 0=TextOnly
- 1=ImageOnly
- 2=ImageLeft (image to the left of the text)
- 3=ImageRight
- buttonText
- Type: System
String
The text (if any) that should be displayed on the button. - tooltip
- Type: System
String
The tooltip text for the button. - imageName
- Type: System
String
The image (if any) for the button. - navGroup
- Type: System
Int32
Indicates which navigation bar group the new button will be added to:- 0=Left
- 1=Middle
- 2=Right
- buttonIndex
- Type: System
Int32
The location within the navigation bar group where the new button will appear. If this is null, the button will just be added to the end of the group. - separator
- Type: System
Int32
Indicates whether or not a separator bar will be placed next to the new button:- 0=None
- 1=Left
- 2=Right
- 3=Both
- callback
- Type: function
A function to which a button ID for the custom button will be passed. You can later use this button ID invoke the button programmatically or to set the button's visibility.
Remarks
See Also