Activates selection tool forcedly.
[C/C++]
HRESULT ForceStartSelection(
VARIANT_BOOL enable
);
[Visual Basic]
object.ForceStartSelection(
ByVal enable As Boolean
)
[C#]
void ITextGRABSDK.ForceStartSelection(
bool enable
);
Parameters
- enable
- [in] specifies if tool should be activated or deactivated. TRUE – activates tool, FALSE – deactivates it.
Remarks
After calling this function mouse cursor will change to cross and user will need to drag a rectangle on screen with left mouse button. When user will release left mouse button – application will receive WM_SELECTION notification (if it was registered with RegisterSelectionNotify method)
Return Value(s)
| Return Value(s) | Definitions |
|---|---|
| S_OK | (0x00000000) Operation was completed successfully. |
| S_FALSE | (0x00000001) Selection tool is already activated/deactivated. |
| E_FAIL | (0x80004005) Error. |