Class InputMethodContext
Definition
- Namespace:
- Tizen.NUI
- Assembly:
- Tizen.NUI.dll
- API Level:
- 5
Specifically manages the input method framework (IMF) that enables the virtual or hardware keyboards.
C#Copypublic class InputMethodContext : BaseHandle, IDynamicResourceHandler, IElement, INameScope, IElementController, System.IDisposable
- Inheritance
- Implements
Constructors
Declaration
C#Copypublic InputMethodContext()
API Level: 5
Properties
Declaration
C#Copypublic bool TextPrediction { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
API Level: 8
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()
API Level: 5
AutoEnableInputPanel(Boolean)
Enables to show the input panel automatically when focused.
Declaration
C#Copypublic void AutoEnableInputPanel(bool enabled)
Parameters
Type | Name | Description |
---|---|---|
Boolean | enabled | If true, the input panel will be shown when focused. |
API Level: 5
Declaration
C#Copypublic void Deactivate()
API Level: 5
Declaration
C#Copypublic void DestroyContext()
API Level: 5
Declaration
C#Copyprotected override void Dispose(DisposeTypes type)
Parameters
Type | Name | Description |
---|---|---|
DisposeTypes | type | Dispose Type |
Overrides
API Level: 5
GetCursorPosition()
Gets the cursor position stored in VirtualKeyboard, this is required by the IMF context.
Declaration
C#Copypublic uint GetCursorPosition()
Returns
Type | Description |
---|---|
UInt32 | The current position of the cursor. |
API Level: 5
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. |
API Level: 5
Declaration
C#Copypublic InputMethodContext.InputPanelLanguage GetInputPanelLanguage()
Returns
Type | Description |
---|---|
InputMethodContext.InputPanelLanguage | The language of the input panel |
API Level: 8
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. |
API Level: 5
Declaration
C#Copypublic InputMethodContext.State GetInputPanelState()
Returns
Type | Description |
---|---|
InputMethodContext.State | The state of the input panel. |
API Level: 5
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. |
API Level: 5
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. |
API Level: 5
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. |
API Level: 5
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. |
API Level: 5
Declaration
C#Copypublic void HideInputPanel()
API Level: 5
NotifyCursorPosition()
Notifies the IMF context that the cursor position has changed, required for features such as auto-capitalization.
Declaration
C#Copypublic void NotifyCursorPosition()
API Level: 5
NotifyTextInputMultiLine(Boolean)
Notifies the IMF context that text input is set to multiline or not.
Declaration
C#Copypublic void NotifyTextInputMultiLine(bool multiLine)
Parameters
Type | Name | Description |
---|---|---|
Boolean | multiLine | True if multiline text input is used. |
API Level: 5
Declaration
C#Copyprotected override void ReleaseSwigCPtr(Runtime.InteropServices.HandleRef swigCPtr)
Parameters
Type | Name | Description |
---|---|---|
Tizen.System.Runtime.InteropServices.HandleRef | swigCPtr |
Overrides
Declaration
C#Copypublic void Reset()
API Level: 5
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 |
---|---|
Boolean | The restoration status. |
API Level: 5
SetCursorPosition(UInt32)
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 |
---|---|---|
UInt32 | cursorPosition | The position of the cursor. |
API Level: 5
SetInputPanelLanguage(InputMethodContext.InputPanelLanguage)
Sets the language of the input panel.
Declaration
C#Copypublic void SetInputPanelLanguage(InputMethodContext.InputPanelLanguage language)
Parameters
Type | Name | Description |
---|---|---|
InputMethodContext.InputPanelLanguage | language | The language to be set to the input panel |
API Level: 8
Declaration
C#Copypublic void SetInputPanelPosition(uint x, uint y)
Parameters
Type | Name | Description |
---|---|---|
UInt32 | x | The top-left x coordinate of the input panel. |
UInt32 | y | The top-left y coordinate of the input panel. |
API Level: 8
Declaration
C#Copypublic void SetInputPanelUserData(string text)
Parameters
Type | Name | Description |
---|---|---|
String | text | The specific data to be set to the input panel. |
API Level: 5
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. |
API Level: 8
SetRestoreAfterFocusLost(Boolean)
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 |
---|---|---|
Boolean | toggle | True means that keyboard must be restored after the focus is lost and regained. |
API Level: 5
SetReturnKeyState(Boolean)
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 |
---|---|---|
Boolean | visible | True if the return key is visible (enabled), false otherwise. |
API Level: 5
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. |
API Level: 5
Declaration
C#Copypublic void ShowInputPanel()
API Level: 5
Events
Declaration
C#Copypublic event EventHandler<InputMethodContext.ActivatedEventArgs> Activated
Event Type
Type | Description |
---|---|
EventHandler<InputMethodContext.ActivatedEventArgs> |
API Level: 5
Declaration
C#Copypublic event EventHandler<InputMethodContext.ContentReceivedEventArgs> ContentReceived
Event Type
Type | Description |
---|---|
EventHandler<InputMethodContext.ContentReceivedEventArgs> |
Declaration
C#Copypublic event EventHandlerWithReturnType<object, InputMethodContext.EventReceivedEventArgs, InputMethodContext.CallbackData> EventReceived
Event Type
Type | Description |
---|---|
EventHandlerWithReturnType<Object, InputMethodContext.EventReceivedEventArgs, InputMethodContext.CallbackData> |
API Level: 5
Declaration
C#Copypublic event EventHandler<InputMethodContext.KeyboardTypeChangedEventArgs> KeyboardTypeChanged
Event Type
Type | Description |
---|---|
EventHandler<InputMethodContext.KeyboardTypeChangedEventArgs> |
API Level: 5
Declaration
C#Copypublic event EventHandler<InputMethodContext.LanguageChangedEventArgs> LanguageChanged
Event Type
Type | Description |
---|---|
EventHandler<InputMethodContext.LanguageChangedEventArgs> |
API Level: 5
Declaration
C#Copypublic event EventHandler<InputMethodContext.ResizedEventArgs> Resized
Event Type
Type | Description |
---|---|
EventHandler<InputMethodContext.ResizedEventArgs> |
API Level: 5
Declaration
C#Copypublic event EventHandler<InputMethodContext.StatusChangedEventArgs> StatusChanged
Event Type
Type | Description |
---|---|
EventHandler<InputMethodContext.StatusChangedEventArgs> |