formZ SDK | 4.0 Call Back Reference | Command | Tool

fz_tool_cbak_can_activate

Description

Tool can activate (Optional). This function is called by formZ BEFORE this tool is made the active tool by the user. The user can activate the tool by clicking on an icon or executing a key shortcut.

This function should be used when it is possible that a tool can not execute because of some condition. An alert should be posted to notify the user of this condition and/or offer a automatic remedy. This is different than which will dimm the inteface (and not give allow for an alert posting)

Plugin Prototype

fzrt_error_td fz_tool_cbak_can_activate(

fzrt_int

windex,

fzrt_boolean *

can_activate )

Parameters

windex [Input]

project window index

can_activate [Result]

toll can be activated (TRUE/FALSE)

Returns

Error codes

Availability

7.0.0.0

See Also

fz_tool_cbak_activate,

Function Set

fz_tool_cbak_fset


Defined in

fz_tool_api.h