Class TextEditor

Definition

Namespace:

Tizen.NUI.BaseComponents

Assembly:

Tizen.NUI.dll

API Level:

3

A control which provides a multi-line editable text editor.

public class TextEditor : View, INotifyPropertyChanged, IDynamicResourceHandler, IElement, INameScope, IElementController, IDisposable, IResourcesProvider

Inheritance

Object

Tizen.NUI.Binding.BindableObject

Tizen.NUI.Binding.Element

BaseHandle

Animatable

Container

View

TextEditor

Implements

INotifyPropertyChanged

IDisposable

Constructors

TextEditor()

Creates the TextEditor control.

Declaration

public TextEditor()

API Level: 3

Properties

CursorBlinkDuration

The CursorBlinkDuration property.

Declaration

public float CursorBlinkDuration { get; set; }

Property Value

Type	Description
Single

API Level: 3

CursorBlinkInterval

The CursorBlinkInterval property.

Declaration

public float CursorBlinkInterval { get; set; }

Property Value

Type	Description
Single

API Level: 3

CursorWidth

The CursorWidth property.

Declaration

public int CursorWidth { get; set; }

Property Value

Type	Description
Int32

API Level: 3

DecorationBoundingBox

The DecorationBoundingBox property.

Declaration

public Rectangle DecorationBoundingBox { get; set; }

Property Value

Type	Description
Rectangle

Remarks

The property cascade chaining set is possible. For example, this (textEditor.DecorationBoundingBox.X = 1;) is possible.

API Level: 3

Emboss

The Emboss property.

Declaration

public string Emboss { get; set; }

Property Value

Type	Description
String

API Level: 3

EnableCursorBlink

The EnableCursorBlink property.

Declaration

public bool EnableCursorBlink { get; set; }

Property Value

Type	Description
Boolean

API Level: 3

EnableMarkup

The EnableMarkup property.

Declaration

public bool EnableMarkup { get; set; }

Property Value

Type	Description
Boolean

API Level: 3

EnableScrollBar

The EnableScrollBar property.

Declaration

public bool EnableScrollBar { get; set; }

Property Value

Type	Description
Boolean

API Level: 3

EnableSelection

The EnableSelection property.

Declaration

public bool EnableSelection { get; set; }

Property Value

Type	Description
Boolean

API Level: 3

FontFamily

The FontFamily property.

Declaration

public string FontFamily { get; set; }

Property Value

Type	Description
String

API Level: 3

FontStyle

The FontStyle property.

Declaration

public PropertyMap FontStyle { get; set; }

Property Value

Type	Description
PropertyMap

API Level: 3

GrabHandleImage

The GrabHandleImage property.

Declaration

public string GrabHandleImage { get; set; }

Property Value

Type	Description
String

API Level: 3

GrabHandlePressedImage

The GrabHandlePressedImage property.

Declaration

public string GrabHandlePressedImage { get; set; }

Property Value

Type	Description
String

API Level: 3

HorizontalAlignment

The HorizontalAlignment property.

Declaration

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

Type	Description
HorizontalAlignment

API Level: 3

InputColor

The InputColor property.

Declaration

public Vector4 InputColor { get; set; }

Property Value

Type	Description
Vector4

Remarks

The property cascade chaining set is possible. For example, this (textEditor.InputColor.X = 0.1f;) is possible.

API Level: 3

InputEmboss

The InputEmboss property.

Declaration

public string InputEmboss { get; set; }

Property Value

Type	Description
String

API Level: 3

InputFontFamily

The InputFontFamily property.

Declaration

public string InputFontFamily { get; set; }

Property Value

Type	Description
String

API Level: 3

InputFontStyle

The InputFontStyle property.

Declaration

public PropertyMap InputFontStyle { get; set; }

Property Value

Type	Description
PropertyMap

API Level: 3

InputLineSpacing

The InputLineSpacing property.

Declaration

public float InputLineSpacing { get; set; }

Property Value

Type	Description
Single

API Level: 3

InputOutline

The InputOutline property.

Declaration

public string InputOutline { get; set; }

Property Value

Type	Description
String

API Level: 3

InputPointSize

The InputPointSize property.

Declaration

public float InputPointSize { get; set; }

Property Value

Type	Description
Single

API Level: 3

InputShadow

The InputShadow property.

Declaration

public string InputShadow { get; set; }

Property Value

Type	Description
String

API Level: 3

InputUnderline

The InputUnderline property.

Declaration

public string InputUnderline { get; set; }

Property Value

Type	Description
String

API Level: 3

LineCount

The line count of the text.

Declaration

public int LineCount { get; }

Property Value

Type	Description
Int32

API Level: 3

LineSpacing

The LineSpacing property.

Declaration

public float LineSpacing { get; set; }

Property Value

Type	Description
Single

API Level: 3

LineWrapMode

The LineWrapMode property.
The line wrap mode when the text lines over the layout width.

Declaration

public LineWrapMode LineWrapMode { get; set; }

Property Value

Type	Description
LineWrapMode

API Level: 4

MatchSystemLanguageDirection

The text alignment to match the direction of the system language.

Declaration

public bool MatchSystemLanguageDirection { get; set; }

Property Value

Type	Description
Boolean

API Level: 6

Outline

The Outline property.

Declaration

public PropertyMap Outline { get; set; }

Property Value

Type	Description
PropertyMap

API Level: 3

PixelSize

The PixelSize property.

Declaration

public float PixelSize { get; set; }

Property Value

Type	Description
Single

API Level: 3

Placeholder

The Placeholder property. Gets or sets the placeholder: text, color, font family, font style, point size, and pixel size.

Declaration

public PropertyMap Placeholder { get; set; }

Property Value

Type	Description
PropertyMap

Examples

The following example demonstrates how to set the placeholder property.

PropertyMap propertyMap = new PropertyMap();
propertyMap.Add("text", new PropertyValue("Setting Placeholder Text"));
propertyMap.Add("textFocused", new PropertyValue("Setting Placeholder Text Focused"));
propertyMap.Add("color", new PropertyValue(Color.Red));
propertyMap.Add("fontFamily", new PropertyValue("Arial"));
propertyMap.Add("pointSize", new PropertyValue(12.0f));

PropertyMap fontStyleMap = new PropertyMap();
fontStyleMap.Add("weight", new PropertyValue("bold"));
fontStyleMap.Add("width", new PropertyValue("condensed"));
fontStyleMap.Add("slant", new PropertyValue("italic"));
propertyMap.Add("fontStyle", new PropertyValue(fontStyleMap));

TextEditor editor = new TextEditor();
editor.Placeholder = propertyMap;

API Level: 3

PlaceholderText

The text to display when the TextEditor is empty and inactive.

Declaration

public string PlaceholderText { get; set; }

Property Value

Type	Description
String

API Level: 3

PlaceholderTextColor

The Placeholder text color.

Declaration

public Color PlaceholderTextColor { get; set; }

Property Value

Type	Description
Color

Remarks

The property cascade chaining set is possible. For example, this (textEditor.PlaceholderTextColor.X = 0.1f;) is possible.

API Level: 3

PointSize

The PointSize property.

Declaration

public float PointSize { get; set; }

Property Value

Type	Description
Single

API Level: 3

PrimaryCursorColor

The PrimaryCursorColor property.

Declaration

public Vector4 PrimaryCursorColor { get; set; }

Property Value

Type	Description
Vector4

Remarks

The property cascade chaining set is possible. For example, this (textEditor.PrimaryCursorColor.X = 0.1f;) is possible.

API Level: 3

ScrollBarFadeDuration

The ScrollBarFadeDuration property.

Declaration

public float ScrollBarFadeDuration { get; set; }

Property Value

Type	Description
Single

API Level: 3

ScrollBarShowDuration

The ScrollBarShowDuration property.

Declaration

public float ScrollBarShowDuration { get; set; }

Property Value

Type	Description
Single

API Level: 3

ScrollSpeed

The ScrollSpeed property.

Declaration

public float ScrollSpeed { get; set; }

Property Value

Type	Description
Single

API Level: 3

ScrollThreshold

The ScrollThreshold property.

Declaration

public float ScrollThreshold { get; set; }

Property Value

Type	Description
Single

API Level: 3

SecondaryCursorColor

The SecondaryCursorColor property.

Declaration

public Vector4 SecondaryCursorColor { get; set; }

Property Value

Type	Description
Vector4

Remarks

The property cascade chaining set is possible. For example, this (textEditor.SecondaryCursorColor.X = 0.1f;) is possible.

API Level: 3

SelectionHandleImageLeft

The SelectionHandleImageLeft property.

Declaration

public PropertyMap SelectionHandleImageLeft { get; set; }

Property Value

Type	Description
PropertyMap

API Level: 3

SelectionHandleImageRight

The SelectionHandleImageRight property.

Declaration

public PropertyMap SelectionHandleImageRight { get; set; }

Property Value

Type	Description
PropertyMap

API Level: 3

SelectionHandleMarkerImageLeft

The SelectionHandleMarkerImageLeft property.

Declaration

public PropertyMap SelectionHandleMarkerImageLeft { get; set; }

Property Value

Type	Description
PropertyMap

API Level: 3

SelectionHandleMarkerImageRight

The SelectionHandleMarkerImageRight property.

Declaration

public PropertyMap SelectionHandleMarkerImageRight { get; set; }

Property Value

Type	Description
PropertyMap

API Level: 3

SelectionHandlePressedImageLeft

The SelectionHandlePressedImageLeft property.

Declaration

public PropertyMap SelectionHandlePressedImageLeft { get; set; }

Property Value

Type	Description
PropertyMap

API Level: 3

SelectionHandlePressedImageRight

The SelectionHandlePressedImageRight property.

Declaration

public PropertyMap SelectionHandlePressedImageRight { get; set; }

Property Value

Type	Description
PropertyMap

API Level: 3

SelectionHighlightColor

The SelectionHighlightColor property.

Declaration

public Vector4 SelectionHighlightColor { get; set; }

Property Value

Type	Description
Vector4

Remarks

The property cascade chaining set is possible. For example, this (textEditor.SelectionHighlightColor.X = 0.1f;) is possible.

API Level: 3

Shadow

The Shadow property.

Declaration

public PropertyMap Shadow { get; set; }

Property Value

Type	Description
PropertyMap

API Level: 3

SmoothScroll

The SmoothScroll property.

Declaration

public bool SmoothScroll { get; set; }

Property Value

Type	Description
Boolean

API Level: 3

SmoothScrollDuration

The SmoothScrollDuration property.

Declaration

public float SmoothScrollDuration { get; set; }

Property Value

Type	Description
Single

API Level: 3

Text

The Text property.

Declaration

public string Text { get; set; }

Property Value

Type	Description
String

API Level: 3

TextColor

The TextColor property.

Declaration

public Vector4 TextColor { get; set; }

Property Value

Type	Description
Vector4

Remarks

The property cascade chaining set is possible. For example, this (textEditor.TextColor.X = 0.1f;) is possible.

API Level: 3

TranslatablePlaceholderText

The TranslatablePlaceholderText property.
The text can set the SID value.

Declaration

public string TranslatablePlaceholderText { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
ArgumentNullException	ResourceManager about multilingual is null.

API Level: 4

TranslatableText

The TranslatableText property.
The text can set the SID value.

Declaration

public string TranslatableText { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
ArgumentNullException	ResourceManager about multilingual is null.

API Level: 4

Underline

The Underline property.

Declaration

public PropertyMap Underline { get; set; }

Property Value

Type	Description
PropertyMap

API Level: 3

Methods

Dispose(DisposeTypes)

Dispose.

Declaration

protected override void Dispose(DisposeTypes type)

Parameters

Type	Name	Description
DisposeTypes	type

Overrides

View.Dispose(DisposeTypes)

API Level: 3

GetInputMethodContext()

Get the InputMethodContext instance.

Declaration

public InputMethodContext GetInputMethodContext()

Returns

Type	Description
InputMethodContext	The InputMethodContext instance.

API Level: 5

Events

ScrollStateChanged

Event for the ScrollStateChanged signal which can be used to subscribe or unsubscribe the event handler provided by the user. The ScrollStateChanged signal is emitted when the scroll state changes.

Declaration

public event EventHandler<TextEditor.ScrollStateChangedEventArgs> ScrollStateChanged

Event Type

Type	Description
EventHandler<TextEditor.ScrollStateChangedEventArgs>

API Level: 3

TextChanged

An event for the TextChanged signal which can be used to subscribe or unsubscribe the event handler provided by the user. The TextChanged signal is emitted when the text changes.

Declaration

public event EventHandler<TextEditor.TextChangedEventArgs> TextChanged

Event Type

Type	Description
EventHandler<TextEditor.TextChangedEventArgs>

API Level: 3

Implements

System.ComponentModel.INotifyPropertyChanged

System.IDisposable