e.document.toolActivated

Revision as of 01:27, 12 June 2017

PDF Editor Layer > Events > e.document.toolActivated

The event is fired when the active tool is being changed.

Name	Type	Description
Param1	PARAM_T	Contains the IPXV_Tool interface of the previously active document. If no documents were active before then NULL will be passed here.
Param2	PARAM_T	Not used.
Handled	VARIANT_BOOL	Not used.
Result	PARAM_T	Not used.

@@ Line 2: / Line 2: @@
 {{#customTitle:e.document.toolActivated}}
 {{#parentPage:PXV:PXV_Events|e.document.toolActivated|event}}
-{{ToWrite}}
 {{ToReview}}
 == Overview ==
-The event is fired when...
+The event is fired when the active tool is being changed.
 == Parameters ==
@@ Line 16: / Line 15: @@
 | class="op_param_name" | Param1
 | style="text-align:center" | PARAM_T
-| Not used.
+| Contains the [[PXV:IPXV_Tool|IPXV_Tool]] interface of the previously active document. If no documents were active before then '''NULL''' will be passed here.
 |-
 | class="op_param_name" | Param2
@@ Line 24: / Line 23: @@
 | class="op_param_name" | Handled
 | style="text-align:center" | 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.
+| Not used.
 |-
 | class="op_param_name" | Result
 | style="text-align:center" | PARAM_T
-| Specifies the result that will be used by the event sender when the event is marked as Handled.
+| Not used.