Class ImfManager

Definition

Namespace:: Tizen.NUI

Assembly:: Tizen.NUI.dll

API Level:: 3

Specifically manages the input method framework which enables the virtual or hardware keyboards.


                C#
                
                    Copy
                    
                
            
public class ImfManager : BaseHandle, IDisposable

Inheritance: Object

BaseHandle

ImfManager

Implements: System.IDisposable

Constructors

View Source

ImfManager()

The constructor.

Declaration


                C#
                
                    Copy
                    
                
            
public ImfManager()

API Level: 3

Methods

View Source

Activate()

Activates the IMF.
It means that the text editing is started somewhere.
If the hardware keyboard isn't connected, then it will show the virtual keyboard.

Declaration


                C#
                
                    Copy
                    
                
            
public void Activate()

API Level: 3

View Source

AutoEnableInputPanel(Boolean)

Enables to show the input panel automatically when focused.

Declaration


                C#
                
                    Copy
                    
                
            
public void AutoEnableInputPanel(bool enabled)

Parameters

Type	Name	Description
Boolean	enabled	If true, the input panel will be shown when focused.

API Level: 3

View Source

Deactivate()

Deactivates the IMF.
It means that the text editing is finished somewhere.

Declaration


                C#
                
                    Copy
                    
                
            
public void Deactivate()

API Level: 3

View Source

Get()

Retrieves a handle to the instance of the ImfManager.

Declaration


                C#
                
                    Copy
                    
                
            
public static ImfManager Get()

Returns

Type	Description
ImfManager	A handle to the ImfManager.

API Level: 3

View Source

GetCursorPosition()

Gets the cursor position stored in VirtualKeyboard, this is required by the IMF context.

Declaration


                C#
                
                    Copy
                    
                
            
public uint GetCursorPosition()

Returns

Type	Description
System.UInt32	The current position of the cursor.

API Level: 3

View Source

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() should be called after Show().

Declaration


                C#
                
                    Copy
                    
                
            
public Rectangle GetInputMethodArea()

Returns

Type	Description
Rectangle	Rectangle which is keyboard panel x, y, width, height.

API Level: 3

View Source

GetInputPanelLocale()

Gets the current language locale of the input panel.
For example, en_US, en_GB, en_PH, fr_FR, ...

Declaration


                C#
                
                    Copy
                    
                
            
public string GetInputPanelLocale()

Returns

Type	Description
System.String	The current language locale of the input panel.

API Level: 4

View Source

GetInputPanelState()

Gets the state of the current active input panel.

Declaration


                C#
                
                    Copy
                    
                
            
public ImfManager.State GetInputPanelState()

Returns

Type	Description
ImfManager.State	The state of the input panel.

API Level: 3

View Source

GetInputPanelUserData(out String)

Gets the specific data of the current active input panel.

Declaration


                C#
                
                    Copy
                    
                
            
public void GetInputPanelUserData(out string text)

Parameters

Type	Name	Description
System.String	text	The specific data to be received from the input panel.

API Level: 4

View Source

GetKeyboardType()

Gets the keyboard type.
The default keyboard type is SoftwareKeyboard.

Declaration


                C#
                
                    Copy
                    
                
            
public ImfManager.KeyboardType GetKeyboardType()

Returns

Type	Description
ImfManager.KeyboardType	The keyboard type.

API Level: 4

View Source

GetSurroundingText()

Gets the current text string set within the IMF manager, this is used to offer predictive suggestions.

Declaration


                C#
                
                    Copy
                    
                
            
public string GetSurroundingText()

Returns

Type	Description
System.String	The surrounding text.

API Level: 3

View Source

GetTextDirection()

Returns the text direction of the keyboard's current input language.

Declaration


                C#
                
                    Copy
                    
                
            
public ImfManager.TextDirection GetTextDirection()

Returns

Type	Description
ImfManager.TextDirection	The direction of the text.

API Level: 3

View Source

HideInputPanel()

Hides the input panel.

Declaration


                C#
                
                    Copy
                    
                
            
public void HideInputPanel()

API Level: 3

View Source

NotifyCursorPosition()

Notifies the IMF context that the cursor position has changed, required for features like auto-capitalization.

Declaration


                C#
                
                    Copy
                    
                
            
public void NotifyCursorPosition()

API Level: 3

View Source

NotifyTextInputMultiLine(Boolean)

Notifies the IMF context that text input is set to multiline or not.

Declaration


                C#
                
                    Copy
                    
                
            
public void NotifyTextInputMultiLine(bool multiLine)

Parameters

Type	Name	Description
Boolean	multiLine	True if multiline text input is used.

API Level: 3

View Source

Reset()

Sends a message reset to the preedit state or the IMF module.

Declaration


                C#
                
                    Copy
                    
                
            
public void Reset()

API Level: 3

View Source

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 focus is regained.

Declaration


                C#
                
                    Copy
                    
                
            
public bool RestoreAfterFocusLost()

Returns

Type	Description
Boolean	The restoration status.

API Level: 3

View Source

SetCursorPosition(UInt32)

Sets the cursor position stored in VirtualKeyboard, this is required by the IMF context.

Declaration


                C#
                
                    Copy
                    
                
            
public void SetCursorPosition(uint cursorPosition)

Parameters

Type	Name	Description
System.UInt32	cursorPosition	The position of the cursor.

API Level: 3

View Source

SetInputPanelUserData(String)

Sets up the input-panel specific data.

Declaration


                C#
                
                    Copy
                    
                
            
public void SetInputPanelUserData(string text)

Parameters

Type	Name	Description
System.String	text	The specific data to be set to the input panel.

API Level: 3

View Source

SetRestoreAfterFocusLost(Boolean)

Sets the status whether the IMF has to restore the keyboard after losing focus.

Declaration


                C#
                
                    Copy
                    
                
            
public void SetRestoreAfterFocusLost(bool toggle)

Parameters

Type	Name	Description
Boolean	toggle	True means that keyboard should be restored after the focus is lost and regained.

API Level: 3

View Source

SetReturnKeyState(Boolean)

Sets the return key on the input panel to be visible or invisible.
The default is true.

Declaration


                C#
                
                    Copy
                    
                
            
public void SetReturnKeyState(bool visible)

Parameters

Type	Name	Description
Boolean	visible	True if the return key is visible (enabled), false otherwise.

API Level: 3

View Source

SetSurroundingText(String)

A method to store the string required by the IMF, this is used to provide predictive word suggestions.

Declaration


                C#
                
                    Copy
                    
                
            
public void SetSurroundingText(string text)

Parameters

Type	Name	Description
System.String	text	The text string surrounding the current cursor point.

API Level: 3

View Source

ShowInputPanel()

Shows the input panel.

Declaration


                C#
                
                    Copy
                    
                
            
public void ShowInputPanel()

API Level: 3

Events

View Source

Activated

ImfManager activated.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<ImfManager.ActivatedEventArgs> Activated

Event Type

Type	Description
System.EventHandler<ImfManager.ActivatedEventArgs>

API Level: 4

View Source

EventReceived

ImfManager event received.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandlerWithReturnType<object, ImfManager.EventReceivedEventArgs, ImfManager.ImfCallbackData> EventReceived

Event Type

Type	Description
EventHandlerWithReturnType<Object, ImfManager.EventReceivedEventArgs, ImfManager.ImfCallbackData>

API Level: 4

View Source

KeyboardTypeChanged

ImfManager keyboard type changed.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<ImfManager.KeyboardTypeChangedEventArgs> KeyboardTypeChanged

Event Type

Type	Description
System.EventHandler<ImfManager.KeyboardTypeChangedEventArgs>

API Level: 4

View Source

LanguageChanged

ImfManager language changed.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<ImfManager.LanguageChangedEventArgs> LanguageChanged

Event Type

Type	Description
System.EventHandler<ImfManager.LanguageChangedEventArgs>

API Level: 4

View Source

Resized

ImfManager resized.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<ImfManager.ResizedEventArgs> Resized

Event Type

Type	Description
System.EventHandler<ImfManager.ResizedEventArgs>

API Level: 4

View Source

StatusChanged

ImfManager status changed.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<ImfManager.StatusChangedEventArgs> StatusChanged

Event Type

Type	Description
System.EventHandler<ImfManager.StatusChangedEventArgs>

API Level: 4

Implements

System.IDisposable