IPenInputPanel::Refresh method (peninputpanel.h)

[Refresh is no longer available for use as of Windows XP Tablet PC Edition. Instead, use Text Input Panel (TIP).]

Updates and restores the PenInputPanel properties based on Tablet PC Input Panel settings, automatically positions the pen input panel, and sets the user interface to the default panel.

Syntax

HRESULT Refresh();

Return value

This method can return one of these values.

Return code	Description
S_OK	Success.
E_UNEXPECTED	Unexpected parameter or property type.
E_FAIL	An unspecified error occurred.

Remarks

The Refresh method restores the default panel. For example, if the DefaultPanel property is set to Keyboard and the CurrentPanel property is set to Handwriting, the Refresh method sets the pen input panel to Keyboard. If the DefaultPanel property is set to Default, the Refresh method does not change the pen input panel.

The Refresh method automatically positions the pen input panel relative to the control to which it is attached.

The Refresh method updates the pen input panel using the Input Panel settings. For instance, you can make changes to the PenInputPanel object, and then call Refresh to restore the settings to those copied from the Input Panel.

The PenInputPanel object is updated automatically whenever the Input Panel settings change.

Calling Refresh while the pen input panel does not have focus will generate an error.

Note  Normally, you won't need to call Refresh because all of the above is executed during activation of the pen input panel. However, if the AutoShow property is set to FALSE, you can disable activation of the pen input panel. Therefore, the Refresh method is needed.

 

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	peninputpanel.h
Library	InkObj.dll

See also

IPenInputPanel

PenInputPanel