Class Entry

Definition

Namespace:

ElmSharp

Assembly:

ElmSharp.dll

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

public class Entry : Layout, IAccessibleObject

Inheritance

object

EvasObject

AccessibleObject

Widget

Container

Layout

Entry

Implements

IAccessibleObject

Constructors

Entry(EvasObject)

Creates and initializes a new instance of the Entry class.

Declaration

public Entry(EvasObject parent)

Parameters

Type	Name	Description
EvasObject	parent	The EvasObject to which the new Entry will be attached as a child.

Properties

AutoCapital

Sets or gets the autocapitalization type on the immodule.

Declaration

public AutoCapital AutoCapital { get; set; }

Property Value

Type	Description
AutoCapital

CopyAndPasteMode

Sets or gets the entry text paste/drop mode.

Declaration

public CopyAndPasteMode CopyAndPasteMode { get; set; }

Property Value

Type	Description
CopyAndPasteMode

CursorGeometry

Gets the geometry of the cursor.

Declaration

public Rect CursorGeometry { get; }

Property Value

Type	Description
Rect

CursorPosition

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

Declaration

public int CursorPosition { get; set; }

Property Value

Type	Description
int

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

public bool HorizontalBounce { get; set; }

Property Value

Type	Description
bool

HorizontalScrollBarVisiblePolicy

Sets or gets the value of the HorizontalScrollBarVisiblePolicy.

Declaration

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.

InputHint

Sets or gets the value of the input hint.

Declaration

public InputHints InputHint { get; set; }

Property Value

Type	Description
InputHints

InputPanelLanguage

Sets or gets the language mode of the input panel.

Declaration

public InputPanelLanguage InputPanelLanguage { get; set; }

Property Value

Type	Description
InputPanelLanguage

InputPanelReturnKeyDisabled

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

Declaration

public bool InputPanelReturnKeyDisabled { get; set; }

Property Value

Type	Description
bool

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

public bool InputPanelShowByOnDemand { get; set; }

Property Value

Type	Description
bool

InputPanelVariation

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

Declaration

public int InputPanelVariation { get; set; }

Property Value

Type	Description
int

IsAutoSave

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

Declaration

public bool IsAutoSave { get; set; }

Property Value

Type	Description
bool

IsCursorFormat

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

Declaration

public bool IsCursorFormat { get; }

Property Value

Type	Description
bool

IsCursorVisibelFormat

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

Declaration

public bool IsCursorVisibelFormat { get; }

Property Value

Type	Description
bool

IsEditable

Sets or gets whether the entry is editable.

Declaration

public bool IsEditable { get; set; }

Property Value

Type	Description
bool

IsEmpty

Sets or gets whether the entry is empty.

Declaration

public bool IsEmpty { get; }

Property Value

Type	Description
bool

IsPassword

Sets or gets the entry to the password mode.

Declaration

public bool IsPassword { get; set; }

Property Value

Type	Description
bool

IsSingleLine

Sets or gets the entry to the single line mode.

Declaration

public bool IsSingleLine { get; set; }

Property Value

Type	Description
bool

LineWrapType

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

Declaration

public WrapType LineWrapType { get; set; }

Property Value

Type	Description
WrapType

PredictionAllowed

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

Declaration

public bool PredictionAllowed { get; set; }

Property Value

Type	Description
bool

Scrollable

Sets or gets the scrollable state of the entry.

Declaration

public bool Scrollable { get; set; }

Property Value

Type	Description
bool

Text

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

Declaration

public override string Text { get; set; }

Property Value

Type	Description
string

Overrides

Widget.Text

TextStyle

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

Declaration

public string TextStyle { get; set; }

Property Value

Type	Description
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').

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

public bool VerticalBounce { get; set; }

Property Value

Type	Description
bool

VerticalScrollBarVisiblePolicy

Sets or gets the value of VerticalScrollBarVisiblePolicy.

Declaration

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.

Methods

AppendItemProvider(Func<string, EvasObject>)

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

Declaration

public void AppendItemProvider(Func<string, EvasObject> func)

Parameters

Type	Name	Description
System.Func<T, TResult><string, EvasObject>	func	This function is used to provide items.

AppendMarkUpFilter(Func<Entry, string, string>)

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

Declaration

public void AppendMarkUpFilter(Func<Entry, string, string> filter)

Parameters

Type	Name	Description
System.Func<T1, T2, TResult><Entry, string, string>	filter	This function type is used by entry filters to modify text.

AppendText(string)

Appends the text of the entry.

Declaration

public void AppendText(string text)

Parameters

Type	Name	Description
string	text	The text to be displayed.

BeginCursorSelection()

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

Declaration

public void BeginCursorSelection()

ConvertMarkupToUtf8(string)

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

Declaration

public static string ConvertMarkupToUtf8(string markup)

Parameters

Type	Name	Description
string	markup	The string (in markup) to be converted.

Returns

Type	Description
string	The converted string (in UTF-8).

CopySelection()

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

Declaration

public void CopySelection()

CreateHandle(EvasObject)

Creates a widget handle.

Declaration

protected override IntPtr CreateHandle(EvasObject parent)

Parameters

Type	Name	Description
EvasObject	parent	Parent EvasObject.

Returns

Type	Description
System.IntPtr	Handle IntPtr.

Overrides

Layout.CreateHandle(EvasObject)

CutSelection()

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

Declaration

public void CutSelection()

DisableSelection(bool)

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

Declaration

public void DisableSelection(bool disable)

Parameters

Type	Name	Description
bool	disable	If true, the selection handlers are disabled.

EndCursorSelection()

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

Declaration

public void EndCursorSelection()

ForceCalculation()

Forces calculation of the entry size and text layout.

Declaration

public void ForceCalculation()

GetCursorContent()

Gets the string by the cursor at its current position.

Declaration

public string GetCursorContent()

Returns

Type	Description
string

GetSelection()

Gets any selected text within the entry.

Declaration

public string GetSelection()

Returns

Type	Description
string	Selection's value.

HideInputPanel()

Hides the input panel (virtual keyboard).

Declaration

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).

InsertTextToCursor(string)

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

Declaration

public void InsertTextToCursor(string text)

Parameters

Type	Name	Description
string	text	The text to be inserted.

MoveCursorBegin()

Moves the cursor to the beginning of the entry.

Declaration

public void MoveCursorBegin()

MoveCursorDown()

Moves the cursor one line down within the entry.

Declaration

public bool MoveCursorDown()

Returns

Type	Description
bool	TRUE on success, otherwise FALSE on failure.

MoveCursorEnd()

Moves the cursor to the end of the entry.

Declaration

public void MoveCursorEnd()

MoveCursorLineBegin()

Moves the cursor to the beginning of the current line.

Declaration

public void MoveCursorLineBegin()

MoveCursorLineEnd()

Moves the cursor to the end of the current line.

Declaration

public void MoveCursorLineEnd()

MoveCursorNext()

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

Declaration

public bool MoveCursorNext()

Returns

Type	Description
bool

MoveCursorPrev()

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

Declaration

public bool MoveCursorPrev()

Returns

Type	Description
bool	TRUE on success, otherwise FALSE on failure.

MoveCursorUp()

Moves the cursor one line up within the entry.

Declaration

public bool MoveCursorUp()

Returns

Type	Description
bool	TRUE on success, otherwise FALSE on failure.

PasteSelection()

This executes a "paste" action in the entry.

Declaration

public void PasteSelection()

PrependItemProvider(Func<string, EvasObject>)

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

Declaration

public void PrependItemProvider(Func<string, EvasObject> func)

Parameters

Type	Name	Description
System.Func<T, TResult><string, EvasObject>	func	This function is used to provide items.

PrependMarkUpFilter(Func<Entry, string, string>)

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

Declaration

public void PrependMarkUpFilter(Func<Entry, string, string> filter)

Parameters

Type	Name	Description
System.Func<T1, T2, TResult><Entry, string, string>	filter	This function type is used by entry filters to modify text.

RemoveItemProvider(Func<string, EvasObject>)

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

Declaration

public void RemoveItemProvider(Func<string, EvasObject> func)

Parameters

Type	Name	Description
System.Func<T, TResult><string, EvasObject>	func	This function is used to provide items.

RemoveMarkUpFilter(Func<Entry, string, string>)

Removes a markup filter.

Declaration

public void RemoveMarkUpFilter(Func<Entry, string, string> filter)

Parameters

Type	Name	Description
System.Func<T1, T2, TResult><Entry, string, string>	filter	This function type is used by entry filters to modify text.

SaveFile()

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

Declaration

public void SaveFile()

SelectAll()

Selects all the text within the entry.

Declaration

public void SelectAll()

SelectNone()

Drops any existing text selection within the entry.

Declaration

public void SelectNone()

SetFile(string, TextFormat)

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

Declaration

public void SetFile(string file, TextFormat textFormat)

Parameters

Type	Name	Description
string	file	The path to the file to load and save.
TextFormat	textFormat	The file format.

SetIconVisible(bool)

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

Declaration

public void SetIconVisible(bool isDisplay)

Parameters

Type	Name	Description
bool	isDisplay	true if the object should be displayed, otherwise false.

SetInputPanelEnabled(bool)

Sets the attribute to show the input panel automatically.

Declaration

public void SetInputPanelEnabled(bool enabled)

Parameters

Type	Name	Description
bool	enabled	If true, the input panel appears when the entry is clicked or has focus, otherwise false.

SetInputPanelLayout(InputPanelLayout)

Sets the input panel layout of the entry.

Declaration

public void SetInputPanelLayout(InputPanelLayout layout)

Parameters

Type	Name	Description
InputPanelLayout	layout	The layout type.

SetInputPanelReturnKeyAutoEnable(bool)

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

Declaration

public void SetInputPanelReturnKeyAutoEnable(bool enable)

Parameters

Type	Name	Description
bool	enable	If enabled is true, the return key is automatically disabled when the entry has no text.

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

public void SetInputPanelReturnKeyType(InputPanelReturnKeyType keyType)

Parameters

Type	Name	Description
InputPanelReturnKeyType	keyType	The type of "return" key on the input panel.

SetSelectionRegion(int, int)

This selects a region of text within the entry.

Declaration

public void SetSelectionRegion(int start, int end)

Parameters

Type	Name	Description
int	start	The start position.
int	end	The end position.

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

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).

Events

Activated

Activated will be triggered when the entry is activated.

Declaration

public event EventHandler Activated

Event Type

Type	Description
System.EventHandler

ChangedByUser

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

Declaration

public event EventHandler ChangedByUser

Event Type

Type	Description
System.EventHandler

Clicked

Clicked will be triggered when the entry is clicked.

Declaration

public event EventHandler Clicked

Event Type

Type	Description
System.EventHandler

CursorChanged

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

Declaration

public event EventHandler CursorChanged

Event Type

Type	Description
System.EventHandler

Implements

IAccessibleObject

Extension Methods

RotaryEventExtensions.Activate(EvasObject)

RotaryEventExtensions.AddRotaryEventHandler(EvasObject, RotaryEventHandler)

RotaryEventExtensions.Deactivate(EvasObject)

RotaryEventExtensions.RemoveRotaryEventHandler(EvasObject, RotaryEventHandler)