Class TextField

Definition

Namespace:

Tizen.NUI.BaseComponents

Assembly:

Tizen.NUI.dll

A control which provides a single line editable text field.

public class TextField : View, INotifyPropertyChanged, IDisposable

Inheritance

object

Tizen.NUI.Binding.BindableObject

Tizen.NUI.Binding.Element

BaseHandle

Animatable

Container

View

TextField

Implements

System.ComponentModel.INotifyPropertyChanged

System.IDisposable

Constructors

TextField()

Creates the TextField control.

Declaration

public TextField()

Properties

CursorBlinkDuration

The CursorBlinkDuration property.

Declaration

public float CursorBlinkDuration { get; set; }

Property Value

Type	Description
float

CursorBlinkInterval

The CursorBlinkInterval property.

Declaration

public float CursorBlinkInterval { get; set; }

Property Value

Type	Description
float

CursorWidth

The CursorWidth property.

Declaration

public int CursorWidth { get; set; }

Property Value

Type	Description
int

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 (textField.DecorationBoundingBox.X = 0.1f;) is possible.

Ellipsis

The Ellipsis property.
Enable or disable the ellipsis.
Placeholder PropertyMap is used to add ellipsis to placeholder text.

Declaration

public bool Ellipsis { get; set; }

Property Value

Type	Description
bool

Emboss

The Emboss property.

Declaration

public string Emboss { get; set; }

Property Value

Type	Description
string

EnableCursorBlink

The EnableCursorBlink property.

Declaration

public bool EnableCursorBlink { get; set; }

Property Value

Type	Description
bool

EnableMarkup

The EnableMarkup property.

Declaration

public bool EnableMarkup { get; set; }

Property Value

Type	Description
bool

EnableSelection

The Enable selection property.

Declaration

public bool EnableSelection { get; set; }

Property Value

Type	Description
bool

ExceedPolicy

The ExceedPolicy property.

Declaration

public int ExceedPolicy { get; set; }

Property Value

Type	Description
int

FontFamily

The FontFamily property.

Declaration

public string FontFamily { get; set; }

Property Value

Type	Description
string

FontStyle

The FontStyle property.

Declaration

public PropertyMap FontStyle { get; set; }

Property Value

Type	Description
PropertyMap

GrabHandleImage

The GrabHandleImage property.

Declaration

public string GrabHandleImage { get; set; }

Property Value

Type	Description
string

GrabHandlePressedImage

The GrabHandlePressedImage property.

Declaration

public string GrabHandlePressedImage { get; set; }

Property Value

Type	Description
string

HiddenInputSettings

The HiddenInputSettings property.

Declaration

public PropertyMap HiddenInputSettings { get; set; }

Property Value

Type	Description
PropertyMap

HorizontalAlignment

The HorizontalAlignment property.

Declaration

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

Type	Description
HorizontalAlignment

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 (textField.InputColor.X = 0.1f;) is possible.

InputEmboss

The InputEmboss property.

Declaration

public string InputEmboss { get; set; }

Property Value

Type	Description
string

InputFontFamily

The InputFontFamily property.

Declaration

public string InputFontFamily { get; set; }

Property Value

Type	Description
string

InputFontStyle

The InputFontStyle property.

Declaration

public PropertyMap InputFontStyle { get; set; }

Property Value

Type	Description
PropertyMap

InputMethodSettings

The InputMethodSettings property.

Declaration

public PropertyMap InputMethodSettings { get; set; }

Property Value

Type	Description
PropertyMap

InputOutline

The InputOutline property.

Declaration

public string InputOutline { get; set; }

Property Value

Type	Description
string

InputPointSize

The InputPointSize property.

Declaration

public float InputPointSize { get; set; }

Property Value

Type	Description
float

InputShadow

The InputShadow property.

Declaration

public string InputShadow { get; set; }

Property Value

Type	Description
string

InputUnderline

The InputUnderline property.

Declaration

public string InputUnderline { get; set; }

Property Value

Type	Description
string

MatchSystemLanguageDirection

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

Declaration

public bool MatchSystemLanguageDirection { get; set; }

Property Value

Type	Description
bool

MaxLength

The MaxLength property.

Declaration

public int MaxLength { get; set; }

Property Value

Type	Description
int

Outline

The Outline property.

Declaration

public PropertyMap Outline { get; set; }

Property Value

Type	Description
PropertyMap

PixelSize

The PixelSize property.

Declaration

public float PixelSize { get; set; }

Property Value

Type	Description
float

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

TextField field = new TextField();
field.Placeholder = propertyMap;

PlaceholderText

The PlaceholderText property.

Declaration

public string PlaceholderText { get; set; }

Property Value

Type	Description
string

PlaceholderTextColor

The PlaceholderTextColor property.

Declaration

public Vector4 PlaceholderTextColor { get; set; }

Property Value

Type	Description
Vector4

Remarks

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

PlaceholderTextFocused

The PlaceholderTextFocused property.

Declaration

public string PlaceholderTextFocused { get; set; }

Property Value

Type	Description
string

PointSize

The PointSize property.

Declaration

public float PointSize { get; set; }

Property Value

Type	Description
float

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 (textField.PrimaryCursorColor.X = 0.1f;) is possible.

ScrollSpeed

The ScrollSpeed property.

Declaration

public float ScrollSpeed { get; set; }

Property Value

Type	Description
float

ScrollThreshold

The ScrollThreshold property.

Declaration

public float ScrollThreshold { get; set; }

Property Value

Type	Description
float

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 (textField.SecondaryCursorColor.X = 0.1f;) is possible.

SelectionHandleImageLeft

The SelectionHandleImageLeft property.

Declaration

public PropertyMap SelectionHandleImageLeft { get; set; }

Property Value

Type	Description
PropertyMap

SelectionHandleImageRight

The SelectionHandleImageRight property.

Declaration

public PropertyMap SelectionHandleImageRight { get; set; }

Property Value

Type	Description
PropertyMap

SelectionHandleMarkerImageLeft

The SelectionHandleMarkerImageLeft property.

Declaration

public PropertyMap SelectionHandleMarkerImageLeft { get; set; }

Property Value

Type	Description
PropertyMap

SelectionHandleMarkerImageRight

The SelectionHandleMarkerImageRight property.

Declaration

public PropertyMap SelectionHandleMarkerImageRight { get; set; }

Property Value

Type	Description
PropertyMap

SelectionHandlePressedImageLeft

The SelectionHandlePressedImageLeft property.

Declaration

public PropertyMap SelectionHandlePressedImageLeft { get; set; }

Property Value

Type	Description
PropertyMap

SelectionHandlePressedImageRight

The SelectionHandlePressedImageRight property.

Declaration

public PropertyMap SelectionHandlePressedImageRight { get; set; }

Property Value

Type	Description
PropertyMap

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 (textField.SelectionHighlightColor.X = 0.1f;) is possible.

Shadow

The Shadow property.

Declaration

public PropertyMap Shadow { get; set; }

Property Value

Type	Description
PropertyMap

ShadowColor

The ShadowColor property.

Declaration

[Obsolete("Please do not use this ShadowColor(Deprecated). Please use Shadow instead.")]
public Vector4 ShadowColor { get; set; }

Property Value

Type	Description
Vector4

Remarks

Deprecated.(API Level 6) Use Shadow instead. The property cascade chaining set is possible. For example, this (textField.ShadowColor.X = 0.1f;) is possible.

ShadowOffset

The ShadowOffset property.

Declaration

[Obsolete("Please do not use this ShadowOffset(Deprecated). Please use Shadow instead.")]
public Vector2 ShadowOffset { get; set; }

Property Value

Type	Description
Vector2

Remarks

Deprecated.(API Level 6) Use Shadow instead. The property cascade chaining set is possible. For example, this (textField.ShadowOffset.X = 0.1f;) is possible.

Text

The Text property.

Declaration

public string Text { get; set; }

Property Value

Type	Description
string

TextColor

The TextColor property.

Declaration

public Color TextColor { get; set; }

Property Value

Type	Description
Color

Remarks

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

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
System.ArgumentNullException	ResourceManager about multilingual is null.

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
System.ArgumentNullException	ResourceManager about multilingual is null.

Underline

The Underline property.

Declaration

public PropertyMap Underline { get; set; }

Property Value

Type	Description
PropertyMap

VerticalAlignment

The VerticalAlignment property.

Declaration

public VerticalAlignment VerticalAlignment { get; set; }

Property Value

Type	Description
VerticalAlignment

Methods

Dispose(DisposeTypes)

Dispose.

Declaration

protected override void Dispose(DisposeTypes type)

Parameters

Type	Name	Description
DisposeTypes	type

Overrides

View.Dispose(DisposeTypes)

GetInputMethodContext()

Get the InputMethodContext instance.

Declaration

public InputMethodContext GetInputMethodContext()

Returns

Type	Description
InputMethodContext	The InputMethodContext instance.

Events

MaxLengthReached

The MaxLengthReached event.

Declaration

public event EventHandler<TextField.MaxLengthReachedEventArgs> MaxLengthReached

Event Type

Type	Description
System.EventHandler<TEventArgs><TextField.MaxLengthReachedEventArgs>

TextChanged

The TextChanged event.

Declaration

public event EventHandler<TextField.TextChangedEventArgs> TextChanged

Event Type

Type	Description
System.EventHandler<TEventArgs><TextField.TextChangedEventArgs>

Implements

System.ComponentModel.INotifyPropertyChanged

System.IDisposable