e.document.beforeSave

From PDF XChange PDF SDK
Jump to: navigation, search
Line 23: Line 23:
 
| class="op_param_name" | Handled
 
| class="op_param_name" | Handled
 
| style="text-align:center" | VARIANT_BOOL
 
| style="text-align:center" | VARIANT_BOOL
| Not used.
+
| Specifies whether the event was handled. Marking the event as handled will cause the event sender to look at the event`s result and act accordingly based on the event type.
 
|-
 
|-
 
| class="op_param_name" | Result
 
| class="op_param_name" | Result
 
| style="text-align:center" | PARAM_T
 
| style="text-align:center" | PARAM_T
| Not used.
+
| Specifies the result that will be used by the event sender when the event is marked as Handled. If the Result is not '''E_NOTIMPL''' then the action execution will no longer be continued.

Revision as of 06:57, 5 April 2017


Overview

The event is fired before the document will be saved. The IEvent interface should be cast to the IPXV_DocSaveEvent interface. This event is used in pair with the After Save Event.

Parameters

Name Type Description
Param1 PARAM_T Not used.
Param2 PARAM_T Not used.
Handled VARIANT_BOOL Specifies whether the event was handled. Marking the event as handled will cause the event sender to look at the event`s result and act accordingly based on the event type.
Result PARAM_T Specifies the result that will be used by the event sender when the event is marked as Handled. If the Result is not E_NOTIMPL then the action execution will no longer be continued.