e.document.beforeSave

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
{{#customTitle:e.document.beforeSave}}
 
{{#customTitle:e.document.beforeSave}}
 
{{#parentPage:PXV:PXV_Events|e.document.beforeSave|event}}
 
{{#parentPage:PXV:PXV_Events|e.document.beforeSave|event}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
 
== Overview ==
 
== Overview ==
The event is fired when...
+
The event is fired before the document will be saved. The [[PXV:IEvent|IEvent]] interface should be cast to the [[PXV:IPXV_DocSaveEvent|IPXV_DocSaveEvent]] interface. This event is used in pair with the [[PXV:e_document_afterSave|After Save Event]].
  
 
== Parameters ==
 
== Parameters ==
Line 28: Line 27:
 
| class="op_param_name" | Result
 
| class="op_param_name" | Result
 
| style="text-align:center" | PARAM_T
 
| style="text-align:center" | PARAM_T
| Specifies the result that will be used by the event sender when the event is marked as Handled.
+
| 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 document saving will no longer be continued.

Latest revision as of 07:02, 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 document saving will no longer be continued.