Class InputMethodContext
Definition
- Assembly:
- Tizen.NUI.dll
Specifically manages the input method framework (IMF) that enables the virtual or hardware keyboards.
C#Copypublic class InputMethodContext : BaseHandle, INotifyPropertyChanged, IDisposable
- Inheritance
- Implements
-
System.ComponentModel.INotifyPropertyChangedSystem.IDisposable
Constructors
Declaration
C#Copy[Obsolete("Deprecated in API8; Will be removed in API10")] public InputMethodContext()
Properties
Declaration
C#Copypublic bool TextPrediction { get; set; }
Property Value
Type | Description |
---|---|
bool |
Methods
Activate()
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
C#Copypublic void Activate()
Declaration
C#Copypublic void AutoEnableInputPanel(bool enabled)
Parameters
Type | Name | Description |
---|---|---|
bool | enabled | If true, the input panel will be shown when focused. |
Declaration
C#Copypublic void Deactivate()
Declaration
C#Copypublic void DestroyContext()
GetCursorPosition()
Gets the cursor position stored in VirtualKeyboard, this is required by the IMF context.
Declaration
C#Copypublic 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
C#Copypublic Rectangle GetInputMethodArea()
Returns
Type | Description |
---|---|
Rectangle | Rectangle which is keyboard panel x, y, width, and height. |
Declaration
C#Copypublic 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
C#Copypublic string GetInputPanelLocale()
Returns
Type | Description |
---|---|
string | The current language locale of the input panel. |
Declaration
C#Copypublic 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
C#Copypublic 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
C#Copypublic 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
C#Copypublic string GetSurroundingText()
Returns
Type | Description |
---|---|
string | The surrounding text. |
GetTextDirection()
Returns the text direction of the current input language of the keyboard.
Declaration
C#Copypublic InputMethodContext.TextDirection GetTextDirection()
Returns
Type | Description |
---|---|
InputMethodContext.TextDirection | The direction of the text. |
Declaration
C#Copypublic void HideInputPanel()
NotifyCursorPosition()
Notifies the IMF context that the cursor position has changed, required for features such as auto-capitalization.
Declaration
C#Copypublic void NotifyCursorPosition()
NotifyTextInputMultiLine(bool)
Notifies the IMF context that text input is set to multiline or not.
Declaration
C#Copypublic void NotifyTextInputMultiLine(bool multiLine)
Parameters
Type | Name | Description |
---|---|---|
bool | multiLine | True if multiline text input is used. |
Declaration
C#Copypublic 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
C#Copypublic 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
C#Copypublic void SetCursorPosition(uint cursorPosition)
Parameters
Type | Name | Description |
---|---|---|
uint | cursorPosition | The position of the cursor. |
Declaration
C#Copypublic void SetInputPanelLanguage(InputMethodContext.InputPanelLanguage language)
Parameters
Type | Name | Description |
---|---|---|
InputMethodContext.InputPanelLanguage | language | The language to be set to the input panel |
Declaration
C#Copypublic 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. |
Declaration
C#Copypublic 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
C#Copypublic 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
C#Copypublic 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
C#Copypublic 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
C#Copypublic void SetSurroundingText(string text)
Parameters
Type | Name | Description |
---|---|---|
string | text | The text string surrounding the current cursor point. |
Declaration
C#Copypublic void ShowInputPanel()
Events
Declaration
C#Copypublic event EventHandler<InputMethodContext.ActivatedEventArgs> Activated
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><InputMethodContext.ActivatedEventArgs> |
Declaration
C#Copypublic event EventHandlerWithReturnType<object, InputMethodContext.EventReceivedEventArgs, InputMethodContext.CallbackData> EventReceived
Event Type
Type | Description |
---|---|
EventHandlerWithReturnType<object, InputMethodContext.EventReceivedEventArgs, InputMethodContext.CallbackData> |
Declaration
C#Copypublic event EventHandler<InputMethodContext.KeyboardTypeChangedEventArgs> KeyboardTypeChanged
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><InputMethodContext.KeyboardTypeChangedEventArgs> |
Declaration
C#Copypublic event EventHandler<InputMethodContext.LanguageChangedEventArgs> LanguageChanged
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><InputMethodContext.LanguageChangedEventArgs> |
Declaration
C#Copypublic event EventHandler<InputMethodContext.ResizedEventArgs> Resized
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><InputMethodContext.ResizedEventArgs> |
Declaration
C#Copypublic event EventHandler<InputMethodContext.StatusChangedEventArgs> StatusChanged
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><InputMethodContext.StatusChangedEventArgs> |