MSInputMethodContext object
Represents IME functionality for a single element.
DOM Information
Inheritance Hierarchy
The MSInputMethodContext does not inherit from any class or interface.
Members
The MSInputMethodContext object has these types of members:
- Events
- Methods
- Properties
Events
The MSInputMethodContext object has these events.
Event | Description |
---|---|
candidatewindowhide | Fires after the IME candidate window is fully hidden. |
candidatewindowshow | Fires immediately after the IME candidate window is set to appear, but before it renders. |
candidatewindowupdate | Fires after the IME candidate window has been identified as needing to change size, but before any visual updates have rendered. |
Methods
The MSInputMethodContext object has these methods.
Method | Description |
---|---|
addEventListener | Registers an event handler for the specified event type. |
getCandidateWindowClientRect | Returns a ClientRect object with candidate window coordinate space information (if the IME candidate window is visible). |
getCompositionAlternatives | Returns a copy of the current list of alternate candidate strings from the MSInputMethodContext object. |
hasComposition | Determines if there is a composition in progress on the element associated with the MSInputMethodContext. |
isCandidateWindowVisible | Returns true if the IME candidate window UI is visible, and false otherwise. |
removeEventListener | Removes an event handler that the addEventListener method registered. |
Properties
The MSInputMethodContext object has these properties.
Property | Access type | Description |
---|---|---|
Read-only |
Returns the ending offset (character position) of the composition relative to the target if a composition is occurring, or zero if there is no composition in progress. |
|
Read-only |
Returns the starting offset (character position) of the composition relative to the target if a composition is occurring, or zero if there is no composition in progress. |
|
Read-only |
Returns the element associated with the MSInputMethodContext. |
Remarks
An instance of this object can be requested from any element using the msGetInputContext method.
A new instance of the MSInputMethodContext object is created on-demand the first time that it is requested on a given element. It can be obtained for any element because any element can become a contenteditable target.
Once created, the lifetime of the MSInputMethodContext object is tied to the lifetime of its corresponding element.