IUIX_CmdHandler::OnNotify Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (6 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_CmdHandler::OnNotify Method}} | {{#customTitle:IUIX_CmdHandler::OnNotify Method}} | ||
| − | {{#parentPage:PXV:IUIX_CmdHandler|method | + | {{#parentPage:PXV:IUIX_CmdHandler#Methods|OnNotify|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Used to notify the execution of the command. When used in custom command handler implementation will handle the command execution. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT OnNotify([in] LONG nCode, [in] IUIX_Cmd* pCmd, [in] IUIX_CmdItem* pItem, [in] IUIX_Obj* pOwner, [in] PARAM_T | + | <pre class="brush:cpp;gutter:false">HRESULT OnNotify([in] LONG nCode, |
| + | [in] IUIX_Cmd* pCmd, | ||
| + | [in] IUIX_CmdItem* pItem, | ||
| + | [in] IUIX_Obj* pOwner, | ||
| + | [in] PARAM_T nNotifyData);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;nCode |
| − | :[in] Value of LONG. | + | :[in] Value of LONG containing the [[PXV:UIX_CmdNotifyCodes|notify code]]. |
| − | ; | + | ;pCmd |
| − | :[in] Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]]. | + | :[in] Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]] containing the command that will be handled. |
| − | ; | + | ;pItem |
| − | :[in] Pointer to [[PXV:IUIX_CmdItem|IUIX_CmdItem]]. | + | :[in] Pointer to [[PXV:IUIX_CmdItem|IUIX_CmdItem]] containing the command item that will be handled. |
| − | ; | + | ;pOwner |
| − | :[in] Pointer to [[PXV:IUIX_Obj|IUIX_Obj]]. | + | :[in] Pointer to [[PXV:IUIX_Obj|IUIX_Obj]] containing the owner object of the command. |
| − | ; | + | ;nNotifyData |
| − | :[in] Value of PARAM_T. | + | :[in] Value of PARAM_T containing the additional notification data. |
== Return Value == | == Return Value == | ||
| Line 26: | Line 30: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IUIX_CmdHandler|IUIX_CmdHandler]] | |
Latest revision as of 02:27, 4 April 2016
Used to notify the execution of the command. When used in custom command handler implementation will handle the command execution.
Syntax
HRESULT OnNotify([in] LONG nCode,
[in] IUIX_Cmd* pCmd,
[in] IUIX_CmdItem* pItem,
[in] IUIX_Obj* pOwner,
[in] PARAM_T nNotifyData);
Parameters
- nCode
- [in] Value of LONG containing the notify code.
- pCmd
- [in] Pointer to IUIX_Cmd containing the command that will be handled.
- pItem
- [in] Pointer to IUIX_CmdItem containing the command item that will be handled.
- pOwner
- [in] Pointer to IUIX_Obj containing the owner object of the command.
- nNotifyData
- [in] Value of PARAM_T containing the additional notification data.
Return Value
Returns S_OK if operation was successful or error code in other cases.
