Class Entry

View Source

Definition

Namespace:
ElmSharp
Assembly:
ElmSharp.dll
API Level:
preview

The Entry is a convenience widget that shows a box in which the user can enter text.


                
C#

                

                    
Copy

                    

                

            
public class Entry : Layout, IAccessibleObject
Inheritance
System.Object
EvasObject
AccessibleObject
Widget
Container
Layout
Entry
Implements
IAccessibleObject

Constructors

View Source

Entry(EvasObject)

Creates and initializes a new instance of the Entry class.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Entry(EvasObject parent)
Parameters
Type Name Description
EvasObject parent

The EvasObject to which the new Entry will be attached as a child.
API Level: preview

Properties

View Source

AutoCapital

Sets or gets the autocapitalization type on the immodule.

Declaration

                
C#

                

                    
Copy

                    

                

            
public AutoCapital AutoCapital { get; set; }
Property Value
Type Description
AutoCapital
API Level: preview
View Source

CopyAndPasteMode

Sets or gets the entry text paste/drop mode.

Declaration

                
C#

                

                    
Copy

                    

                

            
public CopyAndPasteMode CopyAndPasteMode { get; set; }
Property Value
Type Description
CopyAndPasteMode
API Level: preview
View Source

CursorGeometry

Gets the geometry of the cursor.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Rect CursorGeometry { get; }
Property Value
Type Description
Rect
API Level: preview
View Source

CursorPosition

Sets or gets the current position of the cursor in the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public int CursorPosition { get; set; }
Property Value
Type Description
System.Int32
API Level: preview
View Source

HorizontalBounce

Sets or gets the horizontal bounce behavior. When scrolling, the scroller may "bounce" when reaching an edge of the content object. This is a visual way to indicate that the end has reached. This is enabled by default for both the axis. This API will be set if it is enabled for the given axis with boolean parameters for each axis.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool HorizontalBounce { get; set; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

HorizontalScrollBarVisiblePolicy

Sets or gets the value of the HorizontalScrollBarVisiblePolicy.

Declaration

                
C#

                

                    
Copy

                    

                

            
public virtual ScrollBarVisiblePolicy HorizontalScrollBarVisiblePolicy { get; set; }
Property Value
Type Description
ScrollBarVisiblePolicy
Remarks

ScrollBarVisiblePolicy.Auto means that the horizontal scrollbar is made visible if it is needed, or otherwise kept hidden. ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off.

API Level: preview
View Source

InputHint

Sets or gets the value of the input hint.

Declaration

                
C#

                

                    
Copy

                    

                

            
public InputHints InputHint { get; set; }
Property Value
Type Description
InputHints
API Level: preview
View Source

InputPanelLanguage

Sets or gets the language mode of the input panel.

Declaration

                
C#

                

                    
Copy

                    

                

            
public InputPanelLanguage InputPanelLanguage { get; set; }
Property Value
Type Description
InputPanelLanguage
API Level: preview
View Source

InputPanelReturnKeyDisabled

Sets or gets whether the return key on the input panel should be disabled or not.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool InputPanelReturnKeyDisabled { get; set; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

InputPanelShowByOnDemand

Sets or gets the attribute to show the input panel, in case of only an user's explicit Mouse Up event. It doesn't request to show the input panel even though it has focus. If true, the input panel will be shown only in case of the Mouse up event (Focus event will be ignored).

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool InputPanelShowByOnDemand { get; set; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

InputPanelVariation

Sets or gets the input panel layout variation of the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public int InputPanelVariation { get; set; }
Property Value
Type Description
System.Int32
API Level: preview
View Source

IsAutoSave

Sets or gets the entry object's 'autosave' status.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool IsAutoSave { get; set; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

IsCursorFormat

Gets whether a format node exists at the current cursor position.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool IsCursorFormat { get; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

IsCursorVisibelFormat

Gets if the current cursor position holds a visible format node.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool IsCursorVisibelFormat { get; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

IsEditable

Sets or gets whether the entry is editable.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool IsEditable { get; set; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

IsEmpty

Sets or gets whether the entry is empty.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool IsEmpty { get; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

IsPassword

Sets or gets the entry to the password mode.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool IsPassword { get; set; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

IsSingleLine

Sets or gets the entry to the single line mode.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool IsSingleLine { get; set; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

LineWrapType

Sets or gets the line wrap type to use on multiline entries.

Declaration

                
C#

                

                    
Copy

                    

                

            
public WrapType LineWrapType { get; set; }
Property Value
Type Description
WrapType
API Level: preview
View Source

PredictionAllowed

Sets or gets whether the entry should allow to use the text prediction.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool PredictionAllowed { get; set; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

Scrollable

Sets or gets the scrollable state of the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool Scrollable { get; set; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

Text

Sets or gets the text currently shown in the object entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public override string Text { get; set; }
Property Value
Type Description
System.String
Overrides
API Level: preview
View Source

TextStyle

Sets or gets the style on top of the user style stack.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string TextStyle { get; set; }
Property Value
Type Description
System.String
Remarks

If there are styles in the user style stack, the properties in the top style of the user style stack will replace the properties in current theme. The input style is specified in the format, tag='property=value' (i.e., DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold').

API Level: preview
View Source

VerticalBounce

Sets or gets the vertical bounce behavior. When scrolling, the scroller may "bounce" when reaching an edge of the content object. This is a visual way to indicate that the end has reached. This is enabled by default for both the axis. This API will be set if it is enabled for the given axis with boolean parameters for each axis.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool VerticalBounce { get; set; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

VerticalScrollBarVisiblePolicy

Sets or gets the value of VerticalScrollBarVisiblePolicy.

Declaration

                
C#

                

                    
Copy

                    

                

            
public virtual ScrollBarVisiblePolicy VerticalScrollBarVisiblePolicy { get; set; }
Property Value
Type Description
ScrollBarVisiblePolicy
Remarks

ScrollBarVisiblePolicy.Auto means that the vertical scrollbar is made visible if it is needed, or otherwise kept hidden. ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off.

API Level: preview

Methods

View Source

AppendItemProvider(Func<String, EvasObject>)

This appends a custom item provider to the list for that entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void AppendItemProvider(Func<string, EvasObject> func)
Parameters
Type Name Description
Func<System.String, EvasObject> func

This function is used to provide items.
API Level: preview
View Source

AppendMarkUpFilter(Func<Entry, String, String>)

Appends a markup filter function for text inserted in the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void AppendMarkUpFilter(Func<Entry, string, string> filter)
Parameters
Type Name Description
Func<Entry, System.String, System.String> filter

This function type is used by entry filters to modify text.
API Level: preview
View Source

AppendText(String)

Appends the text of the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void AppendText(string text)
Parameters
Type Name Description
System.String text

The text to be displayed.
API Level: preview
View Source

BeginCursorSelection()

Begins a selection within the entry, as though the user was holding down the mouse button to make a selection.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void BeginCursorSelection()
API Level: preview
View Source

ConvertMarkupToUtf8(String)

Converts a markup (HTML-like) string into UTF-8.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static string ConvertMarkupToUtf8(string markup)
Parameters
Type Name Description
System.String markup

The string (in markup) to be converted.
Returns
Type Description
System.String

The converted string (in UTF-8).
API Level: preview
View Source

CopySelection()

This executes a "copy" action on the selected text in the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void CopySelection()
API Level: preview
View Source

CreateHandle(EvasObject)

Creates a widget handle.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override IntPtr CreateHandle(EvasObject parent)
Parameters
Type Name Description
EvasObject parent

Parent EvasObject.
Returns
Type Description
System.IntPtr

Handle IntPtr.
Overrides
API Level: preview
View Source

CutSelection()

This executes a "cut" action on the selected text in the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void CutSelection()
API Level: preview
View Source

DisableSelection(Boolean)

This disables the entry's selection handlers. This works properly on the profile that provides selection handlers.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void DisableSelection(bool disable)
Parameters
Type Name Description
System.Boolean disable

If true, the selection handlers are disabled.
API Level: preview
View Source

EndCursorSelection()

Ends a selection within the entry as though the user had just released the mouse button while making a selection.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void EndCursorSelection()
API Level: preview
View Source

ForceCalculation()

Forces calculation of the entry size and text layout.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void ForceCalculation()
API Level: preview
View Source

GetCursorContent()

Gets the string by the cursor at its current position.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string GetCursorContent()
Returns
Type Description
System.String
API Level: preview
View Source

GetSelection()

Gets any selected text within the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string GetSelection()
Returns
Type Description
System.String

Selection's value.
API Level: preview
View Source

HideInputPanel()

Hides the input panel (virtual keyboard).

Declaration

                
C#

                

                    
Copy

                    

                

            
public void HideInputPanel()
Remarks

Note that the input panel is shown or hidden automatically according to the focus state of the entry widget. This API can be used in case of manually controlling by using SetInputPanelEnabled(false).

API Level: preview
View Source

InsertTextToCursor(String)

Inserts the given text into the entry at the current cursor position.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void InsertTextToCursor(string text)
Parameters
Type Name Description
System.String text

The text to be inserted.
API Level: preview
View Source

MoveCursorBegin()

Moves the cursor to the beginning of the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void MoveCursorBegin()
API Level: preview
View Source

MoveCursorDown()

Moves the cursor one line down within the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool MoveCursorDown()
Returns
Type Description
System.Boolean

TRUE on success, otherwise FALSE on failure.
API Level: preview
View Source

MoveCursorEnd()

Moves the cursor to the end of the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void MoveCursorEnd()
API Level: preview
View Source

MoveCursorLineBegin()

Moves the cursor to the beginning of the current line.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void MoveCursorLineBegin()
API Level: preview
View Source

MoveCursorLineEnd()

Moves the cursor to the end of the current line.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void MoveCursorLineEnd()
API Level: preview
View Source

MoveCursorNext()

Moves the cursor by one position to the right within the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool MoveCursorNext()
Returns
Type Description
System.Boolean
API Level: preview
View Source

MoveCursorPrev()

Moves the cursor one place to the left within the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool MoveCursorPrev()
Returns
Type Description
System.Boolean

TRUE on success, otherwise FALSE on failure.
API Level: preview
View Source

MoveCursorUp()

Moves the cursor one line up within the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool MoveCursorUp()
Returns
Type Description
System.Boolean

TRUE on success, otherwise FALSE on failure.
API Level: preview
View Source

PasteSelection()

This executes a "paste" action in the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void PasteSelection()
API Level: preview
View Source

PrependItemProvider(Func<String, EvasObject>)

This prepends a custom item provider to the list for that entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void PrependItemProvider(Func<string, EvasObject> func)
Parameters
Type Name Description
Func<System.String, EvasObject> func

This function is used to provide items.
API Level: preview
View Source

PrependMarkUpFilter(Func<Entry, String, String>)

Prepends a markup filter function for text inserted in the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void PrependMarkUpFilter(Func<Entry, string, string> filter)
Parameters
Type Name Description
Func<Entry, System.String, System.String> filter

This function type is used by entry filters to modify text.
API Level: preview
View Source

RemoveItemProvider(Func<String, EvasObject>)

This removes a custom item provider to the list for that entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void RemoveItemProvider(Func<string, EvasObject> func)
Parameters
Type Name Description
Func<System.String, EvasObject> func

This function is used to provide items.
API Level: preview
View Source

RemoveMarkUpFilter(Func<Entry, String, String>)

Removes a markup filter.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void RemoveMarkUpFilter(Func<Entry, string, string> filter)
Parameters
Type Name Description
Func<Entry, System.String, System.String> filter

This function type is used by entry filters to modify text.
API Level: preview
View Source

SaveFile()

Writes any changes made to the file that is set by a file.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void SaveFile()
API Level: preview
View Source

SelectAll()

Selects all the text within the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void SelectAll()
API Level: preview
View Source

SelectNone()

Drops any existing text selection within the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void SelectNone()
API Level: preview
View Source

SetFile(String, TextFormat)

Sets the file (and implicitly loads it) for the text to display and then edit.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void SetFile(string file, TextFormat textFormat)
Parameters
Type Name Description
System.String file

The path to the file to load and save.
TextFormat textFormat

The file format.
API Level: preview
View Source

SetIconVisible(Boolean)

Sets the visibility of the left-side widget of the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void SetIconVisible(bool isDisplay)
Parameters
Type Name Description
System.Boolean isDisplay

true if the object should be displayed, otherwise false.
API Level: preview
View Source

SetInputPanelEnabled(Boolean)

Sets the attribute to show the input panel automatically.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void SetInputPanelEnabled(bool enabled)
Parameters
Type Name Description
System.Boolean enabled

If true, the input panel appears when the entry is clicked or has focus, otherwise false.
API Level: preview
View Source

SetInputPanelLayout(InputPanelLayout)

Sets the input panel layout of the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void SetInputPanelLayout(InputPanelLayout layout)
Parameters
Type Name Description
InputPanelLayout layout

The layout type.
API Level: preview
View Source

SetInputPanelReturnKeyAutoEnable(Boolean)

Sets whether the return key on the input panel is disabled automatically, when the entry has no text.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void SetInputPanelReturnKeyAutoEnable(bool enable)
Parameters
Type Name Description
System.Boolean enable

If enabled is true, the return key is automatically disabled when the entry has no text.
API Level: preview
View Source

SetInputPanelReturnKeyType(InputPanelReturnKeyType)

Sets the "return" key type. This type is used to set the string or icon on the "return" key of the input panel.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void SetInputPanelReturnKeyType(InputPanelReturnKeyType keyType)
Parameters
Type Name Description
InputPanelReturnKeyType keyType

The type of "return" key on the input panel.
API Level: preview
View Source

SetSelectionRegion(Int32, Int32)

This selects a region of text within the entry.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void SetSelectionRegion(int start, int end)
Parameters
Type Name Description
System.Int32 start

The start position.
System.Int32 end

The end position.
API Level: preview
View Source

ShowInputPanel()

Show the input panel (virtual keyboard) based on the input panel property of the entry such as layout, autocapital types, and so on.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void ShowInputPanel()
Remarks

Note that the input panel is shown or hidden automatically according to the focus state of the entry widget. This API can be used in the case of manual control by using the SetInputPanelEnabled(false).

API Level: preview

Events

View Source

Activated

Activated will be triggered when the entry is activated.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler Activated
Event Type
Type Description
System.EventHandler
API Level: preview
View Source

ChangedByUser

ChangedByUser will be triggered when the entry is changed by user.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler ChangedByUser
Event Type
Type Description
System.EventHandler
API Level: preview
View Source

Clicked

Clicked will be triggered when the entry is clicked.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler Clicked
Event Type
Type Description
System.EventHandler
API Level: preview
View Source

CursorChanged

CursorChanged will be triggered when the cursor in the entry is changed.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler CursorChanged
Event Type
Type Description
System.EventHandler
API Level: preview

Implements

Extension Methods