SipUp

Description

Occurs when the Soft Input Panel (SIP) is opened.

Event ID

Event ID

Objects

pbm_sipup

Window

Arguments

Argument

Description

flags

UnsignedLong by value.

Values are:

  • 0 — The SIP is off or not visible

  • 1 — The SIP is visible

  • 2 — The SIP is docked

  • 4 — The SIP is locked and the user cannot change its visibility

Flags is the sum of all SIP states and statuses.

Returns

Long. Return code choices (specify in a RETURN statement):

Usage

Because flags is a sum, you can determine the SIP state and status by subtracting the largest values one by one and checking the value that remains. For example:

Examples

Example 1

In the window’s SipUp event, this code returns the SIP type:

SIPIMType sType 

sType = GetSIPType()

See also