ITipAutocompleteClient::RequestShowUI method
Determines whether Input Panel is ready to have the auto complete list shown.
Syntax
HRESULT RequestShowUI(
[in] HWND hWndACList,
[out] BOOL *pfAllowShowing
);
Parameters
-
hWndACList [in]
-
Window handle of the auto complete list user interface.
-
pfAllowShowing [out]
-
FALSE if client recommends to not show the auto complete list user interface. TRUE if the auto complete provider can show the list user interface.
Return value
This method can return one of these values.
Return code | Description |
---|---|
|
Success. |
|
An unspecified error occurred. |
Remarks
This method is called by the auto complete provider when it is about to show the auto complete user interface. If the client's internal state doesn't allow the provider to show the user interface, pfAllowShowing will be set to FALSE. For example, when the text gets sent to the field from the handwriting skin on the Tablet PC Input Panel and the user immediately starts inking, the client will recommend to not show the auto complete user interface, in order to avoid destructing the user's inking, by setting pfAllowShowing to FALSE.
Call RequestShowUI to set the popup auto complete list window handle before you call the ITipAutocompleteClient::PreferredRects Method. Failure to do so will cause an E_INVALIDARG error when calling PreferredRects.
Requirements
Requirement | Value |
---|---|
Minimum supported client |
Windows XP Tablet PC Edition [desktop apps only] |
Minimum supported server |
None supported |
Header |
|
DLL |
|