Assembly.OnPreSaveDocumentEvent Event

This event is fired prior to saving the document. By setting *showui = false, the integration can prevent the user interface relating to saving the document from showing. By setting *override = true, the integration can prevent the save from happening.

Syntax

void OnPreSaveDocumentEvent ( ref string pathName, HotDocs.HDOUTPUTTYPE outputType, out bool showui, out bool override )

Parameters Description
pathName The path and file name that HotDocs believes the file should be saved to. This might be an empty string ("") if there are no indicators. The integration can change this value. If the value is changed, HotDocs will either save the file to the new value (if no user interface is shown), or suggest the new value as the location to save (if the user interface is shown).
outputType The type of document to be saved. It can be one of the following values from the HDOUTPUTTYPE enumeration:
  • HD_OUTPUT_DOCUMENT
  • HD_OUTPUT_ANSWERSUMMARY
  • HD_OUTPUT_QUESTIONSUMMARY
showui Return parameter. Specifies if HotDocs should display any user interface associated with the save:
  • *showui == true means the user interface is shown.
  • *showui == false means the user interface is not shown.
override Return parameter:
  • *override == true means that HotDocs will not perform the file save.
  • *override == false means that HotDocs will continue normally.