Class InputMethodContext
Definition
- Assembly:
- Tizen.NUI.dll
Specifically manages the input method framework (IMF) that enables the virtual or hardware keyboards.
public class InputMethodContext : BaseHandle, INotifyPropertyChanged, IDisposable
- Inheritance
- Implements
-
System.ComponentModel.INotifyPropertyChangedSystem.IDisposable
Constructors
View SourceInputMethodContext()
Constructor.
Declaration
[Obsolete("Deprecated in API8; Will be removed in API10")]
public InputMethodContext()
Properties
View SourceTextPrediction
Gets or sets whether the IM context allows to use the text prediction.
Declaration
public bool TextPrediction { get; set; }
Property Value
Type | Description |
---|---|
bool |
Methods
View SourceActivate()
Activates the IMF.
It means that the text editing has started.
If the hardware keyboard is not connected, then it shows the virtual keyboard.
Declaration
public void Activate()
AutoEnableInputPanel(bool)
Enables to show the input panel automatically when focused.
Declaration
public void AutoEnableInputPanel(bool enabled)
Parameters
Type | Name | Description |
---|---|---|
bool | enabled | If true, the input panel will be shown when focused. |
Deactivate()
Deactivates the IMF.
It means that the text editing is complete.
Declaration
public void Deactivate()
DestroyContext()
Destroys the context of the IMF.
Declaration
public void DestroyContext()
GetCursorPosition()
Gets the cursor position stored in VirtualKeyboard, this is required by the IMF context.
Declaration
public uint GetCursorPosition()
Returns
Type | Description |
---|---|
uint | The current position of the cursor. |
GetInputMethodArea()
Provides the size and the position of the keyboard.
The position is relative to whether the keyboard is visible or not.
If the keyboard is not visible, then the position will be off the screen.
If the keyboard is not being shown when this method is called, the keyboard is partially setup (IMFContext) to get/>
the values then taken down. So ideally, GetInputMethodArea() must be called after Show().
Declaration
public Rectangle GetInputMethodArea()
Returns
Type | Description |
---|---|
Rectangle | Rectangle which is keyboard panel x, y, width, and height. |
GetInputPanelLanguage()
Gets the language of the input panel.
Declaration
public InputMethodContext.InputPanelLanguage GetInputPanelLanguage()
Returns
Type | Description |
---|---|
InputMethodContext.InputPanelLanguage | The language of the input panel |
GetInputPanelLocale()
Gets the current language locale of the input panel.
For example, en_US, en_GB, en_PH, fr_FR, and so on.
Declaration
public string GetInputPanelLocale()
Returns
Type | Description |
---|---|
string | The current language locale of the input panel. |
GetInputPanelState()
Gets the state of the current active input panel.
Declaration
public InputMethodContext.State GetInputPanelState()
Returns
Type | Description |
---|---|
InputMethodContext.State | The state of the input panel. |
GetInputPanelUserData(out string)
Gets the specific data of the current active input panel.
Declaration
public void GetInputPanelUserData(out string text)
Parameters
Type | Name | Description |
---|---|---|
string | text | The specific data to be received from the input panel. |
GetKeyboardType()
Gets the keyboard type.
The default keyboard type is SoftwareKeyboard.
Declaration
public InputMethodContext.KeyboardType GetKeyboardType()
Returns
Type | Description |
---|---|
InputMethodContext.KeyboardType | The keyboard type. |
GetSurroundingText()
Gets the current text string set within the IMF manager, this is used to offer predictive suggestions.
Declaration
public string GetSurroundingText()
Returns
Type | Description |
---|---|
string | The surrounding text. |
GetTextDirection()
Returns the text direction of the current input language of the keyboard.
Declaration
public InputMethodContext.TextDirection GetTextDirection()
Returns
Type | Description |
---|---|
InputMethodContext.TextDirection | The direction of the text. |
HideInputPanel()
Hides the input panel.
Declaration
public void HideInputPanel()
NotifyCursorPosition()
Notifies the IMF context that the cursor position has changed, required for features such as auto-capitalization.
Declaration
public void NotifyCursorPosition()
NotifyTextInputMultiLine(bool)
Notifies the IMF context that text input is set to multiline or not.
Declaration
public void NotifyTextInputMultiLine(bool multiLine)
Parameters
Type | Name | Description |
---|---|---|
bool | multiLine | True if multiline text input is used. |
Reset()
Sends a message reset to the pre-edit state or the IMF module.
Declaration
public void Reset()
RestoreAfterFocusLost()
Gets the restoration status, which controls if the keyboard is restored after the focus is lost and then regained.
If true, then the keyboard will be restored (activated) after the focus is regained.
Declaration
public bool RestoreAfterFocusLost()
Returns
Type | Description |
---|---|
bool | The restoration status. |
SetCursorPosition(uint)
Sets the cursor position stored in VirtualKeyboard, this is required by the IMF context.
Declaration
public void SetCursorPosition(uint cursorPosition)
Parameters
Type | Name | Description |
---|---|---|
uint | cursorPosition | The position of the cursor. |
SetInputPanelLanguage(InputPanelLanguage)
Sets the language of the input panel.
Declaration
public void SetInputPanelLanguage(InputMethodContext.InputPanelLanguage language)
Parameters
Type | Name | Description |
---|---|---|
InputMethodContext.InputPanelLanguage | language | The language to be set to the input panel |
SetInputPanelPosition(uint, uint)
Sets the x,y coordinates of the input panel.
Declaration
public void SetInputPanelPosition(uint x, uint y)
Parameters
Type | Name | Description |
---|---|---|
uint | x | The top-left x coordinate of the input panel. |
uint | y | The top-left y coordinate of the input panel. |
SetInputPanelUserData(string)
Sets up the input panel specific data.
Declaration
public void SetInputPanelUserData(string text)
Parameters
Type | Name | Description |
---|---|---|
string | text | The specific data to be set to the input panel. |
SetMIMEType(string)
Sets the allowed MIME Type to deliver to the input panel.
For example, string mimeType = "text/plain,image/png,image/gif,application/pdf";
Declaration
public void SetMIMEType(string mimeType)
Parameters
Type | Name | Description |
---|---|---|
string | mimeType | The allowed MIME type. |
SetRestoreAfterFocusLost(bool)
Sets the status whether the IMF has to restore the keyboard after losing focus.
Declaration
public void SetRestoreAfterFocusLost(bool toggle)
Parameters
Type | Name | Description |
---|---|---|
bool | toggle | True means that keyboard must be restored after the focus is lost and regained. |
SetReturnKeyState(bool)
Sets the return key on the input panel to be visible or invisible.
The default value is true.
Declaration
public void SetReturnKeyState(bool visible)
Parameters
Type | Name | Description |
---|---|---|
bool | visible | True if the return key is visible (enabled), false otherwise. |
SetSurroundingText(string)
A method to store the string required by the IMF, this is used to provide predictive word suggestions.
Declaration
public void SetSurroundingText(string text)
Parameters
Type | Name | Description |
---|---|---|
string | text | The text string surrounding the current cursor point. |
ShowInputPanel()
Shows the input panel.
Declaration
public void ShowInputPanel()
Events
View SourceActivated
InputMethodContext activated.
Declaration
public event EventHandler<InputMethodContext.ActivatedEventArgs> Activated
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><InputMethodContext.ActivatedEventArgs> |
EventReceived
InputMethodContext event received.
Declaration
public event EventHandlerWithReturnType<object, InputMethodContext.EventReceivedEventArgs, InputMethodContext.CallbackData> EventReceived
Event Type
Type | Description |
---|---|
EventHandlerWithReturnType<object, InputMethodContext.EventReceivedEventArgs, InputMethodContext.CallbackData> |
KeyboardTypeChanged
InputMethodContext keyboard type changed.
Declaration
public event EventHandler<InputMethodContext.KeyboardTypeChangedEventArgs> KeyboardTypeChanged
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><InputMethodContext.KeyboardTypeChangedEventArgs> |
LanguageChanged
InputMethodContext language changed.
Declaration
public event EventHandler<InputMethodContext.LanguageChangedEventArgs> LanguageChanged
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><InputMethodContext.LanguageChangedEventArgs> |
Resized
InputMethodContext resized.
Declaration
public event EventHandler<InputMethodContext.ResizedEventArgs> Resized
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><InputMethodContext.ResizedEventArgs> |
StatusChanged
InputMethodContext status changed.
Declaration
public event EventHandler<InputMethodContext.StatusChangedEventArgs> StatusChanged
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><InputMethodContext.StatusChangedEventArgs> |