SetSeriesStyle  SetSIPType

Chapter 10: PowerScript Functions

SetSIPPreferredState

Description

Displays or hides the soft input panel (SIP) used on the Pocket PC.

Syntax

SetSIPPreferredState ( hwnd, SIPState )

Argument

Description

hwnd

A long that is the handle of the window or control that receives the SIP input.

SIPState

A value of the SIPState enumerated datatype that specifies the display state of the SIP. Values are:

  • SIPUp! – display the input panel

  • SIPDown! – hide the input panel after a timer expires

  • SIPForceDown! – hide the input panel immediately

  • SIPUnchanged! – ignore any pending requests to hide the input panel

Returns

Integer. Returns 0 for success and a negative value for failure. When running on the desktop or in the development environment, SetSIPPreferredState always returns 0.

Usage

Use SetSIPPreferredState to display the input panel when the application requires user input and hide it otherwise.

If you specify SipUp!, any pending SipDown requests are ignored. When you specify SipDown!, a timer is set and the input panel is hidden when the timer expires. This prevents the input panel from flashing if another control requests SipUp!.

If you want the input panel hidden immediately and you are sure there will be no SipUp! requests, specify SipForceDown!.

If you specify SipDown! and then specify SipUnchanged! before the timer expires, the input panel remains in its current state.

Examples

Example 1

These statements in the GetFocus event of a SingleLineEdit control display the input panel when the control gets focus:

integer li_return


li_return = SetSIPPreferredState(Handle(This),SIPUp!)

See also




Copyright © 2004. Sybase Inc. All rights reserved. SetSIPType

View this book as PDF