Class TextField

View Source

Definition

Namespace:
Tizen.NUI.BaseComponents
Assembly:
Tizen.NUI.dll
API Level:
3

A control which provides a single line editable text field.


                
C#

                

                    
Copy

                    

                

            
public class TextField : View, INotifyPropertyChanged, IDynamicResourceHandler, IElement, INameScope, IElementController, IDisposable, IResourcesProvider
Inheritance
Object
Tizen.NUI.Binding.BindableObject
Tizen.NUI.Binding.Element
BaseHandle
Animatable
Container
View
TextField
Implements
System.ComponentModel.INotifyPropertyChanged
System.IDisposable

Constructors

View Source

TextField()

Creates the TextField control.

Declaration

                
C#

                

                    
Copy

                    

                

            
public TextField()
API Level: 3

Properties

View Source

CursorBlinkDuration

The CursorBlinkDuration property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public float CursorBlinkDuration { get; set; }
Property Value
Type Description
System.Single
API Level: 3
View Source

CursorBlinkInterval

The CursorBlinkInterval property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public float CursorBlinkInterval { get; set; }
Property Value
Type Description
System.Single
API Level: 3
View Source

CursorWidth

The CursorWidth property.

Declaration

                
C#

                

                    
Copy

                    

                

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

DecorationBoundingBox

The DecorationBoundingBox property.

Declaration

                
C#

                

                    
Copy

                    

                

            
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.

API Level: 3
View Source

Ellipsis

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

Declaration

                
C#

                

                    
Copy

                    

                

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

Emboss

The Emboss property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string Emboss { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

The EnableCursorBlink property.

Declaration

                
C#

                

                    
Copy

                    

                

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

EnableMarkup

The EnableMarkup property.

Declaration

                
C#

                

                    
Copy

                    

                

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

EnableSelection

The Enable selection property.

Declaration

                
C#

                

                    
Copy

                    

                

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

ExceedPolicy

The ExceedPolicy property.

Declaration

                
C#

                

                    
Copy

                    

                

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

FontFamily

The FontFamily property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string FontFamily { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

FontStyle

The FontStyle property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyMap FontStyle { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

GrabHandleImage

The GrabHandleImage property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string GrabHandleImage { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

GrabHandlePressedImage

The GrabHandlePressedImage property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string GrabHandlePressedImage { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

HiddenInputSettings

The HiddenInputSettings property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyMap HiddenInputSettings { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

HorizontalAlignment

The HorizontalAlignment property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public HorizontalAlignment HorizontalAlignment { get; set; }
Property Value
Type Description
HorizontalAlignment
API Level: 3
View Source

InputColor

The InputColor property.

Declaration

                
C#

                

                    
Copy

                    

                

            
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.

API Level: 3
View Source

InputEmboss

The InputEmboss property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string InputEmboss { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

InputFontFamily

The InputFontFamily property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string InputFontFamily { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

InputFontStyle

The InputFontStyle property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyMap InputFontStyle { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

InputMethodSettings

The InputMethodSettings property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyMap InputMethodSettings { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

InputOutline

The InputOutline property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string InputOutline { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

InputPointSize

The InputPointSize property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public float InputPointSize { get; set; }
Property Value
Type Description
System.Single
API Level: 3
View Source

InputShadow

The InputShadow property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string InputShadow { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

InputUnderline

The InputUnderline property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string InputUnderline { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

MatchSystemLanguageDirection

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

Declaration

                
C#

                

                    
Copy

                    

                

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

MaxLength

The MaxLength property.

Declaration

                
C#

                

                    
Copy

                    

                

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

Outline

The Outline property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyMap Outline { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

PixelSize

The PixelSize property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public float PixelSize { get; set; }
Property Value
Type Description
System.Single
API Level: 3
View Source

Placeholder

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyMap Placeholder { get; set; }
Property Value
Type Description
PropertyMap
Examples

The following example demonstrates how to set the Placeholder property.


                

                

                    
Copy

                    

                

            
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;
API Level: 3
View Source

PlaceholderText

The PlaceholderText property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string PlaceholderText { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

PlaceholderTextColor

The PlaceholderTextColor property.

Declaration

                
C#

                

                    
Copy

                    

                

            
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.

API Level: 3
View Source

PlaceholderTextFocused

The PlaceholderTextFocused property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string PlaceholderTextFocused { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

PointSize

The PointSize property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public float PointSize { get; set; }
Property Value
Type Description
System.Single
API Level: 3
View Source

PrimaryCursorColor

The PrimaryCursorColor property.

Declaration

                
C#

                

                    
Copy

                    

                

            
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.

API Level: 3
View Source

ScrollSpeed

The ScrollSpeed property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public float ScrollSpeed { get; set; }
Property Value
Type Description
System.Single
API Level: 3
View Source

ScrollThreshold

The ScrollThreshold property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public float ScrollThreshold { get; set; }
Property Value
Type Description
System.Single
API Level: 3
View Source

SecondaryCursorColor

The SecondaryCursorColor property.

Declaration

                
C#

                

                    
Copy

                    

                

            
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.

API Level: 3
View Source

SelectionHandleImageLeft

The SelectionHandleImageLeft property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyMap SelectionHandleImageLeft { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

SelectionHandleImageRight

The SelectionHandleImageRight property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyMap SelectionHandleImageRight { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

SelectionHandleMarkerImageLeft

The SelectionHandleMarkerImageLeft property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyMap SelectionHandleMarkerImageLeft { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

SelectionHandleMarkerImageRight

The SelectionHandleMarkerImageRight property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyMap SelectionHandleMarkerImageRight { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

SelectionHandlePressedImageLeft

The SelectionHandlePressedImageLeft property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyMap SelectionHandlePressedImageLeft { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

SelectionHandlePressedImageRight

The SelectionHandlePressedImageRight property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyMap SelectionHandlePressedImageRight { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

SelectionHighlightColor

The SelectionHighlightColor property.

Declaration

                
C#

                

                    
Copy

                    

                

            
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.

API Level: 3
View Source

Shadow

The Shadow property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyMap Shadow { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

ShadowColor

The ShadowColor property.

Declaration

                
C#

                

                    
Copy

                    

                

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

API Level: 3
View Source

ShadowOffset

The ShadowOffset property.

Declaration

                
C#

                

                    
Copy

                    

                

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

API Level: 3
View Source

Text

The Text property.

Declaration

                
C#

                

                    
Copy

                    

                

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

TextColor

The TextColor property.

Declaration

                
C#

                

                    
Copy

                    

                

            
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.

API Level: 3
View Source

TranslatablePlaceholderText

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public string TranslatablePlaceholderText { get; set; }
Property Value
Type Description
System.String
Exceptions
Type Condition
ArgumentNullException

ResourceManager about multilingual is null.
API Level: 4
View Source

TranslatableText

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public string TranslatableText { get; set; }
Property Value
Type Description
System.String
Exceptions
Type Condition
ArgumentNullException

ResourceManager about multilingual is null.
API Level: 4
View Source

Underline

The Underline property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyMap Underline { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

VerticalAlignment

The VerticalAlignment property.

Declaration

                
C#

                

                    
Copy

                    

                

            
public VerticalAlignment VerticalAlignment { get; set; }
Property Value
Type Description
VerticalAlignment
API Level: 3

Methods

View Source

Dispose(DisposeTypes)

Dispose.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override void Dispose(DisposeTypes type)
Parameters
Type Name Description
DisposeTypes type
Overrides
API Level: 3
View Source

GetInputMethodContext()

Get the InputMethodContext instance.

Declaration

                
C#

                

                    
Copy

                    

                

            
public InputMethodContext GetInputMethodContext()
Returns
Type Description
InputMethodContext

The InputMethodContext instance.
API Level: 5

Events

View Source

MaxLengthReached

The MaxLengthReached event.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<TextField.MaxLengthReachedEventArgs> MaxLengthReached
Event Type
Type Description
System.EventHandler<TextField.MaxLengthReachedEventArgs>
API Level: 3
View Source

TextChanged

The TextChanged event.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<TextField.TextChangedEventArgs> TextChanged
Event Type
Type Description
System.EventHandler<TextField.TextChangedEventArgs>
API Level: 3

Implements

System.ComponentModel.INotifyPropertyChanged
System.IDisposable