e.document.beforeRunAction
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 2: | Line 2: | ||
{{#customTitle:e.document.beforeRunAction}} | {{#customTitle:e.document.beforeRunAction}} | ||
{{#parentPage:PXV:PXV_Events|e.document.beforeRunAction|event}} | {{#parentPage:PXV:PXV_Events|e.document.beforeRunAction|event}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
== Overview == | == Overview == | ||
| − | The event is fired | + | The event is fired before the action execution. The [[PXV:IEvent|IEvent]] interface should be cast to the [[PXV:IPXV_DocActionEvent|IPXV_DocActionEvent]] interface to read the [[PXV:IPXC_Action|IPXC_Action]] interface containing the action that is being executed. This event is used in pair with the [[PXV:e_document_afterRunAction|After Run Action 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 '''0''' then the action execution will no longer be continued. |
Latest revision as of 06:32, 5 April 2017
Overview
The event is fired before the action execution. The IEvent interface should be cast to the IPXV_DocActionEvent interface to read the IPXC_Action interface containing the action that is being executed. This event is used in pair with the After Run Action 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 0 then the action execution will no longer be continued. |
