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.

[Obsolete("This has been deprecated in API12")]
public class Entry : Layout, IAccessibleObject

Inheritance: 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

[Obsolete("This has been deprecated in API12")]
public Entry(EvasObject parent)

Parameters

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

Properties

View Source

AutoCapital

Sets or gets the autocapitalization type on the immodule.

Declaration

[Obsolete("This has been deprecated in API12")]
public AutoCapital AutoCapital { get; set; }

Property Value

Type	Description
AutoCapital

View Source

CopyAndPasteMode

Sets or gets the entry text paste/drop mode.

Declaration

[Obsolete("This has been deprecated in API12")]
public CopyAndPasteMode CopyAndPasteMode { get; set; }

Property Value

Type	Description
CopyAndPasteMode

View Source

CursorGeometry

Gets the geometry of the cursor.

Declaration

[Obsolete("This has been deprecated in API12")]
public Rect CursorGeometry { get; }

Property Value

Type	Description
Rect

View Source

CursorPosition

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

Declaration

[Obsolete("This has been deprecated in API12")]
public int CursorPosition { get; set; }

Property Value

Type	Description
int

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

[Obsolete("This has been deprecated in API12")]
public bool HorizontalBounce { get; set; }

Property Value

Type	Description
bool

View Source

HorizontalScrollBarVisiblePolicy

Sets or gets the value of the HorizontalScrollBarVisiblePolicy.

Declaration

[Obsolete("This has been deprecated in API12")]
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.

View Source

InputHint

Sets or gets the value of the input hint.

Declaration

[Obsolete("This has been deprecated in API12")]
public InputHints InputHint { get; set; }

Property Value

Type	Description
InputHints

View Source

InputPanelLanguage

Sets or gets the language mode of the input panel.

Declaration

[Obsolete("This has been deprecated in API12")]
public InputPanelLanguage InputPanelLanguage { get; set; }

Property Value

Type	Description
InputPanelLanguage

View Source

InputPanelReturnKeyDisabled

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

Declaration

[Obsolete("This has been deprecated in API12")]
public bool InputPanelReturnKeyDisabled { get; set; }

Property Value

Type	Description
bool

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

[Obsolete("This has been deprecated in API12")]
public bool InputPanelShowByOnDemand { get; set; }

Property Value

Type	Description
bool

View Source

InputPanelVariation

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

Declaration

[Obsolete("This has been deprecated in API12")]
public int InputPanelVariation { get; set; }

Property Value

Type	Description
int

View Source

IsAutoSave

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

Declaration

[Obsolete("This has been deprecated in API12")]
public bool IsAutoSave { get; set; }

Property Value

Type	Description
bool

View Source

IsCursorFormat

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

Declaration

[Obsolete("This has been deprecated in API12")]
public bool IsCursorFormat { get; }

Property Value

Type	Description
bool

View Source

IsCursorVisibelFormat

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

Declaration

[Obsolete("This has been deprecated in API12")]
public bool IsCursorVisibelFormat { get; }

Property Value

Type	Description
bool

View Source

IsEditable

Sets or gets whether the entry is editable.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool IsEditable { get; set; }

Property Value

Type	Description
bool

View Source

IsEmpty

Sets or gets whether the entry is empty.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool IsEmpty { get; }

Property Value

Type	Description
bool

View Source

IsPassword

Sets or gets the entry to the password mode.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool IsPassword { get; set; }

Property Value

Type	Description
bool

View Source

IsSingleLine

Sets or gets the entry to the single line mode.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool IsSingleLine { get; set; }

Property Value

Type	Description
bool

View Source

LineWrapType

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

Declaration

[Obsolete("This has been deprecated in API12")]
public WrapType LineWrapType { get; set; }

Property Value

Type	Description
WrapType

View Source

PredictionAllowed

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

Declaration

[Obsolete("This has been deprecated in API12")]
public bool PredictionAllowed { get; set; }

Property Value

Type	Description
bool

View Source

Scrollable

Sets or gets the scrollable state of the entry.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool Scrollable { get; set; }

Property Value

Type	Description
bool

View Source

Text

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

Declaration

[Obsolete("This has been deprecated in API12")]
public override string Text { get; set; }

Property Value

Type	Description
string

Overrides

Widget.Text

View Source

TextStyle

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

Declaration

[Obsolete("This has been deprecated in API12")]
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').

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

[Obsolete("This has been deprecated in API12")]
public bool VerticalBounce { get; set; }

Property Value

Type	Description
bool

View Source

VerticalScrollBarVisiblePolicy

Sets or gets the value of VerticalScrollBarVisiblePolicy.

Declaration

[Obsolete("This has been deprecated in API12")]
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

View Source

AppendItemProvider(Func<string, EvasObject>)

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

Declaration

[Obsolete("This has been deprecated in API12")]
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.

View Source

AppendMarkUpFilter(Func<Entry, string, string>)

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

Declaration

[Obsolete("This has been deprecated in API12")]
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.

View Source

AppendText(string)

Appends the text of the entry.

Declaration

[Obsolete("This has been deprecated in API12")]
public void AppendText(string text)

Parameters

Type	Name	Description
string	text	The text to be displayed.

View Source

BeginCursorSelection()

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

Declaration

[Obsolete("This has been deprecated in API12")]
public void BeginCursorSelection()

View Source

ConvertMarkupToUtf8(string)

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

Declaration

[Obsolete("This has been deprecated in API12")]
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).

View Source

CopySelection()

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

Declaration

[Obsolete("This has been deprecated in API12")]
public void CopySelection()

View Source

CreateHandle(EvasObject)

Creates a widget handle.

Declaration

[Obsolete("This has been deprecated in API12")]
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)

View Source

CutSelection()

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

Declaration

[Obsolete("This has been deprecated in API12")]
public void CutSelection()

View Source

DisableSelection(bool)

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

Declaration

[Obsolete("This has been deprecated in API12")]
public void DisableSelection(bool disable)

Parameters

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

View Source

EndCursorSelection()

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

Declaration

[Obsolete("This has been deprecated in API12")]
public void EndCursorSelection()

View Source

ForceCalculation()

Forces calculation of the entry size and text layout.

Declaration

[Obsolete("This has been deprecated in API12")]
public void ForceCalculation()

View Source

GetCursorContent()

Gets the string by the cursor at its current position.

Declaration

[Obsolete("This has been deprecated in API12")]
public string GetCursorContent()

Returns

Type	Description
string

View Source

GetSelection()

Gets any selected text within the entry.

Declaration

[Obsolete("This has been deprecated in API12")]
public string GetSelection()

Returns

Type	Description
string	Selection's value.

View Source

HideInputPanel()

Hides the input panel (virtual keyboard).

Declaration

[Obsolete("This has been deprecated in API12")]
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).

View Source

InsertTextToCursor(string)

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

Declaration

[Obsolete("This has been deprecated in API12")]
public void InsertTextToCursor(string text)

Parameters

Type	Name	Description
string	text	The text to be inserted.

View Source

MoveCursorBegin()

Moves the cursor to the beginning of the entry.

Declaration

[Obsolete("This has been deprecated in API12")]
public void MoveCursorBegin()

View Source

MoveCursorDown()

Moves the cursor one line down within the entry.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool MoveCursorDown()

Returns

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

View Source

MoveCursorEnd()

Moves the cursor to the end of the entry.

Declaration

[Obsolete("This has been deprecated in API12")]
public void MoveCursorEnd()

View Source

MoveCursorLineBegin()

Moves the cursor to the beginning of the current line.

Declaration

[Obsolete("This has been deprecated in API12")]
public void MoveCursorLineBegin()

View Source

MoveCursorLineEnd()

Moves the cursor to the end of the current line.

Declaration

[Obsolete("This has been deprecated in API12")]
public void MoveCursorLineEnd()

View Source

MoveCursorNext()

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

Declaration

[Obsolete("This has been deprecated in API12")]
public bool MoveCursorNext()

Returns

Type	Description
bool

View Source

MoveCursorPrev()

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

Declaration

[Obsolete("This has been deprecated in API12")]
public bool MoveCursorPrev()

Returns

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

View Source

MoveCursorUp()

Moves the cursor one line up within the entry.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool MoveCursorUp()

Returns

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

View Source

PasteSelection()

This executes a "paste" action in the entry.

Declaration

[Obsolete("This has been deprecated in API12")]
public void PasteSelection()

View Source

PrependItemProvider(Func<string, EvasObject>)

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

Declaration

[Obsolete("This has been deprecated in API12")]
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.

View Source

PrependMarkUpFilter(Func<Entry, string, string>)

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

Declaration

[Obsolete("This has been deprecated in API12")]
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.

View Source

RemoveItemProvider(Func<string, EvasObject>)

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

Declaration

[Obsolete("This has been deprecated in API12")]
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.

View Source

RemoveMarkUpFilter(Func<Entry, string, string>)

Removes a markup filter.

Declaration

[Obsolete("This has been deprecated in API12")]
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.

View Source

SaveFile()

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

Declaration

[Obsolete("This has been deprecated in API12")]
public void SaveFile()

View Source

SelectAll()

Selects all the text within the entry.

Declaration

[Obsolete("This has been deprecated in API12")]
public void SelectAll()

View Source

SelectNone()

Drops any existing text selection within the entry.

Declaration

[Obsolete("This has been deprecated in API12")]
public void SelectNone()

View Source

SetFile(string, TextFormat)

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

Declaration

[Obsolete("This has been deprecated in API12")]
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.

View Source

SetIconVisible(bool)

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

Declaration

[Obsolete("This has been deprecated in API12")]
public void SetIconVisible(bool isDisplay)

Parameters

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

View Source

SetInputPanelEnabled(bool)

Sets the attribute to show the input panel automatically.

Declaration

[Obsolete("This has been deprecated in API12")]
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.

View Source

SetInputPanelLayout(InputPanelLayout)

Sets the input panel layout of the entry.

Declaration

[Obsolete("This has been deprecated in API12")]
public void SetInputPanelLayout(InputPanelLayout layout)

Parameters

Type	Name	Description
InputPanelLayout	layout	The layout type.

View Source

SetInputPanelReturnKeyAutoEnable(bool)

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

Declaration

[Obsolete("This has been deprecated in API12")]
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.

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

[Obsolete("This has been deprecated in API12")]
public void SetInputPanelReturnKeyType(InputPanelReturnKeyType keyType)

Parameters

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

View Source

SetSelectionRegion(int, int)

This selects a region of text within the entry.

Declaration

[Obsolete("This has been deprecated in API12")]
public void SetSelectionRegion(int start, int end)

Parameters

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

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

[Obsolete("This has been deprecated in API12")]
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

View Source

Activated

Activated will be triggered when the entry is activated.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler Activated

Event Type

Type	Description
System.EventHandler

View Source

ChangedByUser

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

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler ChangedByUser

Event Type

Type	Description
System.EventHandler

View Source

Clicked

Clicked will be triggered when the entry is clicked.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler Clicked

Event Type

Type	Description
System.EventHandler

View Source

CursorChanged

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

Declaration

[Obsolete("This has been deprecated in API12")]
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)