Class TextEditor

Definition

Namespace:
Tizen.NUI.BaseComponents
Assembly:
Tizen.NUI.dll

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

public class TextEditor : View, IDynamicResourceHandler, INameScope, System.IDisposable, IResourcesProvider
Inheritance
object
BindableObject
Element
BaseHandle
Animatable
Container
View
TextEditor
Implements
IDynamicResourceHandler
INameScope
System.IDisposable
IResourcesProvider

Constructors

View Source

TextEditor()

Creates the TextEditor control. This returns a handle to the TextEditor control.

Declaration
public TextEditor()
View Source

TextEditor(bool)

Creates the TextEditor with setting the status of shown or hidden.

Declaration
public TextEditor(bool shown)
Parameters
Type Name Description
bool shown

false : Not displayed (hidden), true : displayed (shown)
View Source

TextEditor(TextEditorStyle)

Creates the TextEditor with specified style.

Declaration
public TextEditor(TextEditorStyle style)
Parameters
Type Name Description
TextEditorStyle style

Fields

View Source

CharacterSpacingProperty

Declaration
public static readonly BindableProperty CharacterSpacingProperty
Field Value
Type Description
BindableProperty
View Source

CursorBlinkDurationProperty

Declaration
public static readonly BindableProperty CursorBlinkDurationProperty
Field Value
Type Description
BindableProperty
View Source

CursorBlinkIntervalProperty

Declaration
public static readonly BindableProperty CursorBlinkIntervalProperty
Field Value
Type Description
BindableProperty
View Source

CursorWidthProperty

Declaration
public static readonly BindableProperty CursorWidthProperty
Field Value
Type Description
BindableProperty
View Source

DecorationBoundingBoxProperty

Declaration
public static readonly BindableProperty DecorationBoundingBoxProperty
Field Value
Type Description
BindableProperty
View Source

EllipsisPositionProperty

Declaration
public static readonly BindableProperty EllipsisPositionProperty
Field Value
Type Description
BindableProperty
View Source

EllipsisProperty

Declaration
public static readonly BindableProperty EllipsisProperty
Field Value
Type Description
BindableProperty
View Source

EmbossProperty

Declaration
public static readonly BindableProperty EmbossProperty
Field Value
Type Description
BindableProperty
View Source

EnableCursorBlinkProperty

Declaration
public static readonly BindableProperty EnableCursorBlinkProperty
Field Value
Type Description
BindableProperty
View Source

EnableEditingProperty

EnableEditingProperty

Declaration
public static readonly BindableProperty EnableEditingProperty
Field Value
Type Description
BindableProperty
View Source

EnableFontSizeScaleProperty

Declaration
public static readonly BindableProperty EnableFontSizeScaleProperty
Field Value
Type Description
BindableProperty
View Source

EnableGrabHandlePopupProperty

Declaration
public static readonly BindableProperty EnableGrabHandlePopupProperty
Field Value
Type Description
BindableProperty
View Source

EnableGrabHandleProperty

Declaration
public static readonly BindableProperty EnableGrabHandleProperty
Field Value
Type Description
BindableProperty
View Source

EnableMarkupProperty

Declaration
public static readonly BindableProperty EnableMarkupProperty
Field Value
Type Description
BindableProperty
View Source

EnableScrollBarProperty

Declaration
public static readonly BindableProperty EnableScrollBarProperty
Field Value
Type Description
BindableProperty
View Source

EnableSelectionProperty

Declaration
public static readonly BindableProperty EnableSelectionProperty
Field Value
Type Description
BindableProperty
View Source

EnableShiftSelectionProperty

Declaration
public static readonly BindableProperty EnableShiftSelectionProperty
Field Value
Type Description
BindableProperty
View Source

FontFamilyProperty

Declaration
public static readonly BindableProperty FontFamilyProperty
Field Value
Type Description
BindableProperty
View Source

FontSizeScaleProperty

Declaration
public static readonly BindableProperty FontSizeScaleProperty
Field Value
Type Description
BindableProperty
View Source

FontStyleProperty

Declaration
public static readonly BindableProperty FontStyleProperty
Field Value
Type Description
BindableProperty
View Source

GrabHandleColorProperty

Declaration
public static readonly BindableProperty GrabHandleColorProperty
Field Value
Type Description
BindableProperty
View Source

GrabHandleImageProperty

Declaration
public static readonly BindableProperty GrabHandleImageProperty
Field Value
Type Description
BindableProperty
View Source

GrabHandlePressedImageProperty

Declaration
public static readonly BindableProperty GrabHandlePressedImageProperty
Field Value
Type Description
BindableProperty
View Source

HorizontalAlignmentProperty

Declaration
public static readonly BindableProperty HorizontalAlignmentProperty
Field Value
Type Description
BindableProperty
View Source

HorizontalScrollPositionProperty

HorizontalScrollPositionProperty

Declaration
public static readonly BindableProperty HorizontalScrollPositionProperty
Field Value
Type Description
BindableProperty
View Source

InputColorProperty

Declaration
public static readonly BindableProperty InputColorProperty
Field Value
Type Description
BindableProperty
View Source

InputEmbossProperty

Declaration
public static readonly BindableProperty InputEmbossProperty
Field Value
Type Description
BindableProperty
View Source

InputFontFamilyProperty

Declaration
public static readonly BindableProperty InputFontFamilyProperty
Field Value
Type Description
BindableProperty
View Source

InputFontStyleProperty

Declaration
public static readonly BindableProperty InputFontStyleProperty
Field Value
Type Description
BindableProperty
View Source

InputLineSpacingProperty

Declaration
public static readonly BindableProperty InputLineSpacingProperty
Field Value
Type Description
BindableProperty
View Source

InputMethodSettingsProperty

Declaration
public static readonly BindableProperty InputMethodSettingsProperty
Field Value
Type Description
BindableProperty
View Source

InputOutlineProperty

Declaration
public static readonly BindableProperty InputOutlineProperty
Field Value
Type Description
BindableProperty
View Source

InputPointSizeProperty

Declaration
public static readonly BindableProperty InputPointSizeProperty
Field Value
Type Description
BindableProperty
View Source

InputShadowProperty

Declaration
public static readonly BindableProperty InputShadowProperty
Field Value
Type Description
BindableProperty
View Source

InputUnderlineProperty

Declaration
public static readonly BindableProperty InputUnderlineProperty
Field Value
Type Description
BindableProperty
View Source

LineSpacingProperty

Declaration
public static readonly BindableProperty LineSpacingProperty
Field Value
Type Description
BindableProperty
View Source

LineWrapModeProperty

Declaration
public static readonly BindableProperty LineWrapModeProperty
Field Value
Type Description
BindableProperty
View Source

MatchSystemLanguageDirectionProperty

Declaration
public static readonly BindableProperty MatchSystemLanguageDirectionProperty
Field Value
Type Description
BindableProperty
View Source

MaxLengthProperty

Declaration
public static readonly BindableProperty MaxLengthProperty
Field Value
Type Description
BindableProperty
View Source

MinLineSizeProperty

Declaration
public static readonly BindableProperty MinLineSizeProperty
Field Value
Type Description
BindableProperty
View Source

OutlineProperty

Declaration
public static readonly BindableProperty OutlineProperty
Field Value
Type Description
BindableProperty
View Source

PixelSizeProperty

Declaration
public static readonly BindableProperty PixelSizeProperty
Field Value
Type Description
BindableProperty
View Source

PlaceholderProperty

Declaration
public static readonly BindableProperty PlaceholderProperty
Field Value
Type Description
BindableProperty
View Source

PlaceholderTextColorProperty

Declaration
public static readonly BindableProperty PlaceholderTextColorProperty
Field Value
Type Description
BindableProperty
View Source

PlaceholderTextProperty

Declaration
public static readonly BindableProperty PlaceholderTextProperty
Field Value
Type Description
BindableProperty
View Source

PointSizeProperty

Declaration
public static readonly BindableProperty PointSizeProperty
Field Value
Type Description
BindableProperty
View Source

PrimaryCursorColorProperty

Declaration
public static readonly BindableProperty PrimaryCursorColorProperty
Field Value
Type Description
BindableProperty
View Source

PrimaryCursorPositionProperty

PrimaryCursorPositionProperty

Declaration
public static readonly BindableProperty PrimaryCursorPositionProperty
Field Value
Type Description
BindableProperty
View Source

RelativeLineHeightProperty

Declaration
public static readonly BindableProperty RelativeLineHeightProperty
Field Value
Type Description
BindableProperty
View Source

RemoveBackInsetProperty

RemoveBackInsetProperty

Declaration
public static readonly BindableProperty RemoveBackInsetProperty
Field Value
Type Description
BindableProperty
View Source

RemoveFrontInsetProperty

RemoveFrontInsetProperty

Declaration
public static readonly BindableProperty RemoveFrontInsetProperty
Field Value
Type Description
BindableProperty
View Source

ScrollBarFadeDurationProperty

Declaration
public static readonly BindableProperty ScrollBarFadeDurationProperty
Field Value
Type Description
BindableProperty
View Source

ScrollBarShowDurationProperty

Declaration
public static readonly BindableProperty ScrollBarShowDurationProperty
Field Value
Type Description
BindableProperty
View Source

ScrollSpeedProperty

Declaration
public static readonly BindableProperty ScrollSpeedProperty
Field Value
Type Description
BindableProperty
View Source

ScrollThresholdProperty

Declaration
public static readonly BindableProperty ScrollThresholdProperty
Field Value
Type Description
BindableProperty
View Source

SecondaryCursorColorProperty

Declaration
public static readonly BindableProperty SecondaryCursorColorProperty
Field Value
Type Description
BindableProperty
View Source

SelectionHandleImageLeftProperty

Declaration
public static readonly BindableProperty SelectionHandleImageLeftProperty
Field Value
Type Description
BindableProperty
View Source

SelectionHandleImageRightProperty

Declaration
public static readonly BindableProperty SelectionHandleImageRightProperty
Field Value
Type Description
BindableProperty
View Source

SelectionHandleMarkerImageLeftProperty

Declaration
public static readonly BindableProperty SelectionHandleMarkerImageLeftProperty
Field Value
Type Description
BindableProperty
View Source

SelectionHandleMarkerImageRightProperty

Declaration
public static readonly BindableProperty SelectionHandleMarkerImageRightProperty
Field Value
Type Description
BindableProperty
View Source

SelectionHandlePressedImageLeftProperty

Declaration
public static readonly BindableProperty SelectionHandlePressedImageLeftProperty
Field Value
Type Description
BindableProperty
View Source

SelectionHandlePressedImageRightProperty

Declaration
public static readonly BindableProperty SelectionHandlePressedImageRightProperty
Field Value
Type Description
BindableProperty
View Source

SelectionHighlightColorProperty

Declaration
public static readonly BindableProperty SelectionHighlightColorProperty
Field Value
Type Description
BindableProperty
View Source

SelectionPopupStyleProperty

Declaration
public static readonly BindableProperty SelectionPopupStyleProperty
Field Value
Type Description
BindableProperty
View Source

ShadowProperty

Declaration
public static readonly BindableProperty ShadowProperty
Field Value
Type Description
BindableProperty
View Source

SmoothScrollDurationProperty

Declaration
public static readonly BindableProperty SmoothScrollDurationProperty
Field Value
Type Description
BindableProperty
View Source

SmoothScrollProperty

Declaration
public static readonly BindableProperty SmoothScrollProperty
Field Value
Type Description
BindableProperty
View Source

TextColorProperty

Declaration
public static readonly BindableProperty TextColorProperty
Field Value
Type Description
BindableProperty
View Source

TextProperty

Declaration
public static readonly BindableProperty TextProperty
Field Value
Type Description
BindableProperty
View Source

TranslatablePlaceholderTextProperty

TranslatablePlaceholderTextProperty

Declaration
public static readonly BindableProperty TranslatablePlaceholderTextProperty
Field Value
Type Description
BindableProperty
View Source

TranslatableTextProperty

TranslatableTextProperty

Declaration
public static readonly BindableProperty TranslatableTextProperty
Field Value
Type Description
BindableProperty
View Source

UnderlineProperty

Declaration
public static readonly BindableProperty UnderlineProperty
Field Value
Type Description
BindableProperty
View Source

VerticalAlignmentProperty

Declaration
public static readonly BindableProperty VerticalAlignmentProperty
Field Value
Type Description
BindableProperty
View Source

VerticalScrollPositionProperty

VerticalScrollPositionProperty

Declaration
public static readonly BindableProperty VerticalScrollPositionProperty
Field Value
Type Description
BindableProperty

Properties

View Source

CharacterSpacing

The spaces between characters in Pixels. A positive value will make the characters far apart (expanded) and a negative value will bring them closer (condensed).
The default value is 0.f which does nothing.

Declaration
public float CharacterSpacing { get; set; }
Property Value
Type Description
float
View Source

CursorBlinkDuration

The CursorBlinkDuration property.
The cursor will stop blinking after this number of seconds (if non-zero).

Declaration
public float CursorBlinkDuration { get; set; }
Property Value
Type Description
float
View Source

CursorBlinkInterval

The CursorBlinkInterval property.
The time interval in seconds between cursor on/off states.

Declaration
public float CursorBlinkInterval { get; set; }
Property Value
Type Description
float
View Source

CursorWidth

Gets or sets the width of the cursor.

Declaration
public int CursorWidth { get; set; }
Property Value
Type Description
int
View Source

DecorationBoundingBox

The DecorationBoundingBox property.
The decorations (handles etc) will positioned within this area on-screen.

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.

View Source

Ellipsis

The Ellipsis property.
Enable or disable the ellipsis.

Declaration
public bool Ellipsis { get; set; }
Property Value
Type Description
bool
View Source

EllipsisPosition

The ellipsis position of the text. Specifies which portion of the text should be replaced with an ellipsis when the text size exceeds the layout size.

Declaration
public EllipsisPosition EllipsisPosition { get; set; }
Property Value
Type Description
EllipsisPosition
View Source

Emboss

The Emboss property.
The default emboss parameters.

Declaration
public string Emboss { get; set; }
Property Value
Type Description
string
View Source

The EnableCursorBlink property.
Whether the cursor should blink or not.

Declaration
public bool EnableCursorBlink { get; set; }
Property Value
Type Description
bool
View Source

EnableEditing

Enable editing in text control.

Declaration
public bool EnableEditing { get; set; }
Property Value
Type Description
bool
View Source

EnableFontSizeScale

The EnableFontSizeScale property.
Whether the font size scale is enabled. (The default value is true)

Declaration
public bool EnableFontSizeScale { get; set; }
Property Value
Type Description
bool
View Source

EnableGrabHandle

The Enable grab handle property.
Enables the grab handles for text selection.
The default value is true, which means the grab handles are enabled by default.

Declaration
public bool EnableGrabHandle { get; set; }
Property Value
Type Description
bool
View Source

EnableGrabHandlePopup

The Enable grab handle popup property.
Enables the grab handle popup for text selection.
The default value is true, which means the grab handle popup is enabled by default.

Declaration
public bool EnableGrabHandlePopup { get; set; }
Property Value
Type Description
bool
View Source

EnableMarkup

The EnableMarkup property.
Whether the mark-up processing is enabled.

Declaration
public bool EnableMarkup { get; set; }
Property Value
Type Description
bool
View Source

EnableScrollBar

The EnableScrollBar property.
Enable or disable the scroll bar.

Declaration
public bool EnableScrollBar { get; set; }
Property Value
Type Description
bool
View Source

EnableSelection

The Enable selection property.
Enables Text selection, such as the cursor, handle, clipboard, and highlight color.

Declaration
public bool EnableSelection { get; set; }
Property Value
Type Description
bool
View Source

EnableShiftSelection

Enables Text selection using Shift key.

Declaration
public bool EnableShiftSelection { get; set; }
Property Value
Type Description
bool
View Source

FontFamily

The FontFamily property.
The requested font family to use.

Declaration
public string FontFamily { get; set; }
Property Value
Type Description
string
View Source

FontSizeScale

The FontSizeScale property.
The default value is 1.0.
The given font size scale value is used for multiplying the specified font size before querying fonts.
If FontSizeScale.UseSystemSetting, will use the SystemSettings.FontSize internally.

Declaration
public float FontSizeScale { get; set; }
Property Value
Type Description
float
View Source

FontStyle

The FontStyle property.
The requested font style to use.
The fontStyle map contains the following keys :

width (string)The width key defines occupied by each glyph. (values: ultraCondensed, extraCondensed, condensed, semiCondensed, normal, semiExpanded, expanded, extraExpanded, ultraExpanded)
weight (string)The weight key defines the thickness or darkness of the glyphs. (values: thin, ultraLight, extraLight, light, demiLight, semiLight, book, normal, regular, medium, demiBold, semiBold, bold, ultraBold, extraBold, black, heavy, extraBlack)
slant (string)The slant key defines whether to use italics. (values: normal, roman, italic, oblique)
Declaration
public PropertyMap FontStyle { get; set; }
Property Value
Type Description
PropertyMap
View Source

GrabHandleColor

The GrabHandleColor property.

Declaration
public Color GrabHandleColor { get; set; }
Property Value
Type Description
Color
Remarks

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

View Source

GrabHandleImage

The GrabHandleImage property.
The image to display for the grab handle.

Declaration
public string GrabHandleImage { get; set; }
Property Value
Type Description
string
View Source

GrabHandlePressedImage

The GrabHandlePressedImage property.
The image to display when the grab handle is pressed.

Declaration
public string GrabHandlePressedImage { get; set; }
Property Value
Type Description
string
View Source

HorizontalAlignment

The HorizontalAlignment property.
The line horizontal alignment.

Declaration
public HorizontalAlignment HorizontalAlignment { get; set; }
Property Value
Type Description
HorizontalAlignment
View Source

HorizontalScrollPosition

Specify horizontal scroll position in text control.

Declaration
public int HorizontalScrollPosition { get; set; }
Property Value
Type Description
int
View Source

InputColor

The InputColor property.
The color of the new input text.

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.

View Source

InputEmboss

The InputEmboss property.
The emboss parameters of the new input text.

Declaration
public string InputEmboss { get; set; }
Property Value
Type Description
string
View Source

InputFontFamily

The InputFontFamily property.
The font's family of the new input text.

Declaration
public string InputFontFamily { get; set; }
Property Value
Type Description
string
View Source

InputFontStyle

The InputFontStyle property.
The font's style of the new input text.
The inputFontStyle map contains the following keys :

width (string)The width key defines occupied by each glyph. (values: ultraCondensed, extraCondensed, condensed, semiCondensed, normal, semiExpanded, expanded, extraExpanded, ultraExpanded)
weight (string)The weight key defines the thickness or darkness of the glyphs. (values: thin, ultraLight, extraLight, light, demiLight, semiLight, book, normal, regular, medium, demiBold, semiBold, bold, ultraBold, extraBold, black, heavy, extraBlack)
slant (string)The slant key defines whether to use italics. (values: normal, roman, italic, oblique)
Declaration
public PropertyMap InputFontStyle { get; set; }
Property Value
Type Description
PropertyMap
View Source

InputLineSpacing

The InputLineSpacing property.
The extra space between lines in points.

Declaration
public float InputLineSpacing { get; set; }
Property Value
Type Description
float
View Source

InputMethodSettings

The InputMethodSettings property.
The settings to relating to the System's Input Method, Key and Value.

Declaration
public PropertyMap InputMethodSettings { get; set; }
Property Value
Type Description
PropertyMap
Remarks

InputMethod is a class encapsulating the input method map. Use the InputMethod class for this property.

Examples

The following example demonstrates how to set the InputMethodSettings property.

InputMethod method = new InputMethod();
method.PanelLayout = InputMethod.PanelLayoutType.Normal;
method.ActionButton = InputMethod.ActionButtonTitleType.Default;
method.AutoCapital = InputMethod.AutoCapitalType.Word;
method.Variation = 1;
textEditor.InputMethodSettings = method.OutputMap;
View Source

InputOutline

The InputOutline property.
The outline parameters of the new input text.

Declaration
public string InputOutline { get; set; }
Property Value
Type Description
string
View Source

InputPointSize

The InputPointSize property.
The font's size of the new input text in points.

Declaration
public float InputPointSize { get; set; }
Property Value
Type Description
float
View Source

InputShadow

The InputShadow property.
The shadow parameters of the new input text.

Declaration
public string InputShadow { get; set; }
Property Value
Type Description
string
View Source

InputUnderline

The InputUnderline property.
The underline parameters of the new input text.

Declaration
public string InputUnderline { get; set; }
Property Value
Type Description
string
View Source

LineCount

Gets the line count of the text.

Declaration
public int LineCount { get; }
Property Value
Type Description
int
View Source

LineSpacing

The LineSpacing property.
The default extra space between lines in points.

Declaration
public float LineSpacing { get; set; }
Property Value
Type Description
float
View Source

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
View Source

MatchSystemLanguageDirection

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

Declaration
public bool MatchSystemLanguageDirection { get; set; }
Property Value
Type Description
bool
View Source

MaxLength

The MaxLength property.
The maximum number of characters that can be inserted.

Declaration
public int MaxLength { get; set; }
Property Value
Type Description
int
View Source

MinLineSize

Minimum line size to be used.
The height of the line in points.
If the font size is larger than the line size, it works with the font size.

Declaration
public float MinLineSize { get; set; }
Property Value
Type Description
float
View Source

Outline

The Outline property.
The default outline parameters.
The outline map contains the following keys :

color (Color)The color of the outline (the default color is Color.White)
width (float)The width in pixels of the outline (If not provided then the outline is not enabled)
Declaration
public PropertyMap Outline { get; set; }
Property Value
Type Description
PropertyMap
View Source

PixelSize

The PixelSize property.
The size of font in pixels.

Declaration
public float PixelSize { get; set; }
Property Value
Type Description
float
View Source

Placeholder

The Placeholder property. The placeholder map contains the following keys :

text (string)The text to display when the TextEditor is empty and inactive
textFocused (string)The text to display when the placeholder has focus
color (Color)The color of the placeholder text
fontFamily (string)The fontFamily of the placeholder text
fontStyle (PropertyMap)The fontStyle of the placeholder text
pointSize (float)The pointSize of the placeholder text
pixelSize (float)The pixelSize of the placeholder text
ellipsis (bool)The ellipsis of the placeholder text
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;
View Source

PlaceholderText

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

Declaration
public string PlaceholderText { get; set; }
Property Value
Type Description
string
View Source

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.

View Source

PointSize

The PointSize property.
The size of font in points.

Declaration
public float PointSize { get; set; }
Property Value
Type Description
float
View Source

PrimaryCursorColor

The PrimaryCursorColor property.
The color to apply to the primary cursor.

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.

View Source

PrimaryCursorPosition

PrimaryCursorPosition property.
Specify the position of the primary cursor (caret) in text control.

Declaration
public int PrimaryCursorPosition { get; set; }
Property Value
Type Description
int
Remarks

If the value set is out of range (negative or greater than or equal the number of characters in Text) then the PrimaryCursorPosition is moved to the end of Text (the number of characters in Text).

View Source

RelativeLineHeight

The relative height of the line (a factor that will be multiplied by text height).
If the value is less than 1, the lines could to be overlapped.

Declaration
public float RelativeLineHeight { get; set; }
Property Value
Type Description
float
View Source

RemoveBackInset

The RemoveBackInset property.
This property is used when the advance of last glyph must not be trimmed.
When set to false, The gap between the last glyph's rightmost pixel and X coordinate that next glyph will be placed is included in the width of text label.

Declaration
public bool RemoveBackInset { get; set; }
Property Value
Type Description
bool
View Source

RemoveFrontInset

The RemoveFrontInset property.
This property is used when the xBearing of first glyph must not be trimmed.
When set to false, The gap between (0, 0) from the first glyph's leftmost pixel is included in the width of text label.

Declaration
public bool RemoveFrontInset { get; set; }
Property Value
Type Description
bool
View Source

ScrollBarFadeDuration

The ScrollBarFadeDuration property.
Sets the duration of scroll bar to fade out.

Declaration
public float ScrollBarFadeDuration { get; set; }
Property Value
Type Description
float
View Source

ScrollBarShowDuration

The ScrollBarShowDuration property.
Sets the duration of scroll bar to show.

Declaration
public float ScrollBarShowDuration { get; set; }
Property Value
Type Description
float
View Source

ScrollSpeed

The ScrollSpeed property.
The scroll speed in pixels per second.

Declaration
public float ScrollSpeed { get; set; }
Property Value
Type Description
float
View Source

ScrollThreshold

The ScrollThreshold property.
Horizontal scrolling will occur if the cursor is this close to the control border.

Declaration
public float ScrollThreshold { get; set; }
Property Value
Type Description
float
View Source

SecondaryCursorColor

The SecondaryCursorColor property.
The color to apply to the secondary cursor.

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.

View Source

SelectedText

The portion of the text that has been selected by the user.

Declaration
public string SelectedText { get; }
Property Value
Type Description
string
Remarks

Empty string when nothing is selected.

View Source

SelectedTextEnd

The end index for selection.

Declaration
public int SelectedTextEnd { get; }
Property Value
Type Description
int
Remarks

When there is no selection, the index is current cursor position.

View Source

SelectedTextStart

The start index for selection.

Declaration
public int SelectedTextStart { get; }
Property Value
Type Description
int
Remarks

When there is no selection, the index is current cursor position.

View Source

SelectionHandleImageLeft

The SelectionHandleImageLeft property.
The image to display for the left selection handle.
The selectionHandleImageLeft map contains the following key :

filename (string)The path of image file
Declaration
public PropertyMap SelectionHandleImageLeft { get; set; }
Property Value
Type Description
PropertyMap
View Source

SelectionHandleImageRight

The SelectionHandleImageRight property.
The image to display for the right selection handle.
The selectionHandleImageRight map contains the following key :

filename (string)The path of image file
Declaration
public PropertyMap SelectionHandleImageRight { get; set; }
Property Value
Type Description
PropertyMap
View Source

SelectionHandleMarkerImageLeft

The SelectionHandleMarkerImageLeft property.
The image to display for the left selection handle marker.
The selectionHandleMarkerImageLeft map contains the following key :

filename (string)The path of image file
Declaration
public PropertyMap SelectionHandleMarkerImageLeft { get; set; }
Property Value
Type Description
PropertyMap
View Source

SelectionHandleMarkerImageRight

The SelectionHandleMarkerImageRight property.
The image to display for the right selection handle marker.
The selectionHandleMarkerImageRight map contains the following key :

filename (string)The path of image file
Declaration
public PropertyMap SelectionHandleMarkerImageRight { get; set; }
Property Value
Type Description
PropertyMap
View Source

SelectionHandlePressedImageLeft

The SelectionHandlePressedImageLeft property.
The image to display when the left selection handle is pressed.
The selectionHandlePressedImageLeft map contains the following key :

filename (string)The path of image file
Declaration
public PropertyMap SelectionHandlePressedImageLeft { get; set; }
Property Value
Type Description
PropertyMap
View Source

SelectionHandlePressedImageRight

The SelectionHandlePressedImageRight property.
The image to display when the right selection handle is pressed.
The selectionHandlePressedImageRight map contains the following key :

filename (string)The path of image file
Declaration
public PropertyMap SelectionHandlePressedImageRight { get; set; }
Property Value
Type Description
PropertyMap
View Source

SelectionHighlightColor

The SelectionHighlightColor property.
The color of the selection highlight.

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.

View Source

SelectionPopupStyle

The SelectionPopupStyle property.
The style of the text selection popup can be set through SelectionPopupStyle property.

Declaration
public PropertyMap SelectionPopupStyle { get; set; }
Property Value
Type Description
PropertyMap
View Source

Shadow

The Shadow property.
The default shadow parameters.
The shadow map contains the following keys :

color (Color)The color of the shadow (the default color is Color.Black)
offset (Vector2)The offset in pixels of the shadow (If not provided then the shadow is not enabled)
blurRadius (float)The radius of the Gaussian blur for the soft shadow (If not provided then the soft shadow is not enabled)
Declaration
public PropertyMap Shadow { get; set; }
Property Value
Type Description
PropertyMap
View Source

SmoothScroll

The SmoothScroll property.
Enable or disable the smooth scroll animation.

Declaration
public bool SmoothScroll { get; set; }
Property Value
Type Description
bool
View Source

SmoothScrollDuration

The SmoothScrollDuration property.
Sets the duration of smooth scroll animation.

Declaration
public float SmoothScrollDuration { get; set; }
Property Value
Type Description
float
View Source

Text

The Text property.
The text to display in the UTF-8 format.

Declaration
public string Text { get; set; }
Property Value
Type Description
string
View Source

TextColor

The TextColor property.
The color of the text.

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.

View Source

TranslatablePlaceholderText

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

Declaration
public string TranslatablePlaceholderText { get; set; }
Property Value
Type Description
string
View Source

TranslatableText

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

Declaration
public string TranslatableText { get; set; }
Property Value
Type Description
string
View Source

Underline

The Underline property.
The default underline parameters.
The underline map contains the following keys :

enable (bool)Whether the underline is enabled (the default value is false)
color (Color)The color of the underline (If not provided then the color of the text is used)
height (float)The height in pixels of the underline (the default value is 1.f)
Declaration
public PropertyMap Underline { get; set; }
Property Value
Type Description
PropertyMap
View Source

VerticalAlignment

The VerticalAlignment property.
The line vertical alignment.

Declaration
public VerticalAlignment VerticalAlignment { get; set; }
Property Value
Type Description
VerticalAlignment
View Source

VerticalScrollPosition

Specify vertical scroll position in text control.

Declaration
public int VerticalScrollPosition { get; set; }
Property Value
Type Description
int

Methods

View Source

Dispose(DisposeTypes)

Dispose. Releases unmanaged and optionally managed resources.

Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Type Name Description
DisposeTypes type

Explicit to release both managed and unmanaged resources. Implicit to release only unmanaged resources.
Overrides
Remarks

When overriding this method, you need to distinguish between explicit and implicit conditions. For explicit conditions, release both managed and unmanaged resources. For implicit conditions, only release unmanaged resources.

View Source

GetFontStyle()

Get FontStyle from TextEditor.

Declaration
public FontStyle GetFontStyle()
Returns
Type Description
FontStyle

The FontStyle
Remarks

FontStyle

View Source

GetInputFilter()

Get InputFilter from TextEditor.

Declaration
public InputFilter GetInputFilter()
Returns
Type Description
InputFilter

The InputFilter
Remarks

InputFilter

View Source

GetInputFontStyle()

Get InputFontStyle from TextEditor.

Declaration
public FontStyle GetInputFontStyle()
Returns
Type Description
FontStyle

The FontStyle
Remarks

FontStyle

View Source

GetInputMethodContext()

Get the InputMethodContext instance.

Declaration
public InputMethodContext GetInputMethodContext()
Returns
Type Description
InputMethodContext

The InputMethodContext instance.
View Source

GetOutline()

Get Outline from TextEditor.

Declaration
public Outline GetOutline()
Returns
Type Description
Outline

The Outline
Remarks

Outline

View Source

GetPlaceholder()

Get Placeholder from TextEditor.

Declaration
public Placeholder GetPlaceholder()
Returns
Type Description
Placeholder

The Placeholder
Remarks

Placeholder

View Source

GetSelectionHandleImage()

Get SelectionHandleImage from TextEditor.

Declaration
public SelectionHandleImage GetSelectionHandleImage()
Returns
Type Description
SelectionHandleImage

The SelectionHandleImage
Remarks

SelectionHandleImage

View Source

GetSelectionHandleMarkerImage()

Get SelectionHandleMarkerImage from TextEditor.

Declaration
public SelectionHandleImage GetSelectionHandleMarkerImage()
Returns
Type Description
SelectionHandleImage

The SelectionHandleMarkerImage
Remarks

SelectionHandleImage

View Source

GetSelectionHandlePressedImage()

Get SelectionHandlePressedImage from TextEditor.

Declaration
public SelectionHandleImage GetSelectionHandlePressedImage()
Returns
Type Description
SelectionHandleImage

The SelectionHandlePressedImage
Remarks

SelectionHandleImage

View Source

GetShadow()

Get Shadow from TextEditor.

Declaration
public Shadow GetShadow()
Returns
Type Description
Shadow

The Shadow
Remarks

Shadow

View Source

GetStrikethrough()

Get Strikethrough from TextEditor.

Declaration
public Strikethrough GetStrikethrough()
Returns
Type Description
Strikethrough

The Strikethrough
Remarks

Strikethrough

View Source

GetStringProperty(string)

Gets a string property by name.

Declaration
public string GetStringProperty(string propertyName)
Parameters
Type Name Description
string propertyName

The name of the property to retrieve.
Returns
Type Description
string

The string value of the property, or null if not found.
View Source

GetUnderline()

Get Underline from TextEditor.

Declaration
public Underline GetUnderline()
Returns
Type Description
Underline

The Underline
Remarks

Underline

View Source

RegisterFontVariationProperty(string)

Registers FontVariationsProperty with string tag.

Declaration
public int RegisterFontVariationProperty(string tag)
Parameters
Type Name Description
string tag

The tag of font variation.
Returns
Type Description
int

The index of the font variation.
Remarks

The returned index can be used with setting property or animations.

Examples

The following example demonstrates how to use the SetFontStyle method.

TextEditor editor = new TextEditor();
int index = editor.RegisterFontVariationProperty("wght");
Animation anim = new Animation(1000);
anim.AnimateTo(editor, "wght", 900.0f);
View Source

ReleaseSwigCPtr(HandleRef)

Declaration
protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
Parameters
Type Name Description
System.Runtime.InteropServices.HandleRef swigCPtr
Overrides
View Source

ScrollBy(Vector2)

Scroll the text control by specific amount..

Declaration
public void ScrollBy(Vector2 scroll)
Parameters
Type Name Description
Vector2 scroll

The amount (in pixels) of scrolling in horizontal & vertical directions.
View Source

SelectNone()

Clear selection of the text.
Valid when selection is activate.

Declaration
public void SelectNone()
View Source

SelectText(int, int)

Select text from start to end index.
The index is valid when 0 or positive.

Declaration
public void SelectText(int start, int end)
Parameters
Type Name Description
int start

The start index for selection.
int end

The end index for selection.
Remarks

If the end index exceeds the maximum value, it is set to the length of the text.

View Source

SelectWholeText()

Selects the entire text within the TextEditor control.

Declaration
public void SelectWholeText()
View Source

SetFontStyle(FontStyle)

Set FontStyle to TextEditor.

Declaration
public void SetFontStyle(FontStyle fontStyle)
Parameters
Type Name Description
FontStyle fontStyle

The FontStyle
Remarks

SetFontStyle specifies the requested font style through FontStyle.

Examples

The following example demonstrates how to use the SetFontStyle method.

var fontStyle = new Tizen.NUI.Text.FontStyle();
fontStyle.Width = FontWidthType.Expanded;
fontStyle.Weight = FontWeightType.Bold;
fontStyle.Slant = FontSlantType.Italic;
editor.SetFontStyle(fontStyle);
View Source

SetFontVariation(int, float)

Sets Font Variation with index.

Declaration
public void SetFontVariation(int index, float value)
Parameters
Type Name Description
int index

The index of font variation property.
float value

The value of font variation.
Remarks

To use the index, RegisterFontVariationProperty must precede it.

View Source

SetFontVariation(string, float)

Sets Font Variation with string tag.

Declaration
public void SetFontVariation(string tag, float value)
Parameters
Type Name Description
string tag

The tag of font variation.
float value

The value of font variation.
View Source

SetInputFilter(InputFilter)

Set InputFilter to TextEditor.

Declaration
public void SetInputFilter(InputFilter inputFilter)
Parameters
Type Name Description
InputFilter inputFilter

The InputFilter
Remarks

InputFilter filters input based on regular expressions.
InputFiltered signal is emitted when the input is filtered by InputFilter
See InputFiltered, InputFilterType and InputFilteredEventArgs for a detailed description.

Examples

The following example demonstrates how to use the SetInputFilter method.

var inputFilter = new Tizen.NUI.Text.InputFilter();
inputFilter.Accepted = @"[\d]"; // accept whole digits
inputFilter.Rejected = "[0-3]"; // reject 0, 1, 2, 3
editor.SetInputFilter(inputFilter); // acceptable inputs are 4, 5, 6, 7, 8, 9
View Source

SetInputFontStyle(FontStyle)

Set InputFontStyle to TextEditor.

Declaration
public void SetInputFontStyle(FontStyle fontStyle)
Parameters
Type Name Description
FontStyle fontStyle

The FontStyle
Remarks

SetInputFontStyle specifies the requested font style for new input text through FontStyle.

Examples

The following example demonstrates how to use the SetInputFontStyle method.

var fontStyle = new Tizen.NUI.Text.FontStyle();
fontStyle.Width = FontWidthType.Expanded;
fontStyle.Weight = FontWeightType.Bold;
fontStyle.Slant = FontSlantType.Italic;
editor.SetInputFontStyle(fontStyle);
View Source

SetOutline(Outline)

Set Outline to TextEditor.

Declaration
public void SetOutline(Outline outline)
Parameters
Type Name Description
Outline outline

The Outline
Remarks

SetOutline specifies the outline of the text through Outline.

Examples

The following example demonstrates how to use the SetOutline method.

var outline = new Tizen.NUI.Text.Outline();
outline.Width = 2.0f;
outline.Color = new Color("#45B39D");
editor.SetOutline(outline);
View Source

SetPlaceholder(Placeholder)

Set Placeholder to TextEditor.

Declaration
public void SetPlaceholder(Placeholder placeholder)
Parameters
Type Name Description
Placeholder placeholder

The Placeholder
Remarks

SetPlaceholder specifies the attributes of the placeholder property through Placeholder.

Examples

The following example demonstrates how to use the SetPlaceholder method.

var placeholder = new Tizen.NUI.Text.Placeholder();
placeholder.Text = "placeholder text";
placeholder.TextFocused = "placeholder textFocused";
placeholder.Color = new Color("#45B39D");
placeholder.FontFamily = "BreezeSans";
placeholder.FontStyle = new Tizen.NUI.Text.FontStyle()
{
    Width = FontWidthType.Expanded,
    Weight = FontWeightType.ExtraLight,
    Slant = FontSlantType.Italic,
};
placeholder.PointSize = 25.0f;
//placeholder.PixelSize = 50.0f;
placeholder.Ellipsis = true;
editor.SetPlaceholder(placeholder);
View Source

SetSelectionHandleImage(SelectionHandleImage)

Set SelectionHandleImage to TextEditor.

Declaration
public void SetSelectionHandleImage(SelectionHandleImage selectionHandleImage)
Parameters
Type Name Description
SelectionHandleImage selectionHandleImage

The SelectionHandleImage
Remarks

SetSelectionHandleImage specifies the display image used for the selection handle through SelectionHandleImage.

Examples

The following example demonstrates how to use the SetSelectionHandleImage method.

var selectionHandleImage = new Tizen.NUI.Text.SelectionHandleImage();
selectionHandleImage.LeftImageUrl = "handle_downleft.png";
selectionHandleImage.RightImageUrl = "handle_downright.png";
editor.SetSelectionHandleImage(selectionHandleImage);
View Source

SetSelectionHandleMarkerImage(SelectionHandleImage)

Set SelectionHandleMarkerImage to TextEditor.

Declaration
public void SetSelectionHandleMarkerImage(SelectionHandleImage selectionHandleMarkerImage)
Parameters
Type Name Description
SelectionHandleImage selectionHandleMarkerImage

The SelectionHandleImage
Remarks

SetSelectionHandleMarkerImage specifies the display image used for the selection handle through SelectionHandleImage.

Examples

The following example demonstrates how to use the SetSelectionHandleMarkerImage method.

var selectionHandleMarkerImage = new Tizen.NUI.Text.SelectionHandleImage();
selectionHandleMarkerImage.LeftImageUrl = "handle_pressed_downleft.png";
selectionHandleMarkerImage.RightImageUrl = "handle_pressed_downright.png";
editor.SetSelectionHandleMarkerImage(selectionHandleMarkerImage);
View Source

SetSelectionHandlePressedImage(SelectionHandleImage)

Set SelectionHandlePressedImage to TextEditor.

Declaration
public void SetSelectionHandlePressedImage(SelectionHandleImage selectionHandlePressedImage)
Parameters
Type Name Description
SelectionHandleImage selectionHandlePressedImage

The SelectionHandleImage
Remarks

SetSelectionHandlePressedImage specifies the display image used for the selection handle through SelectionHandleImage.

Examples

The following example demonstrates how to use the SetSelectionHandlePressedImage method.

var selectionHandlePressedImage = new Tizen.NUI.Text.SelectionHandleImage();
selectionHandlePressedImage.LeftImageUrl = "handle_pressed_downleft.png";
selectionHandlePressedImage.RightImageUrl = "handle_pressed_downright.png";
editor.SetSelectionHandlePressedImage(selectionHandlePressedImage);
View Source

SetShadow(Shadow)

Set Shadow to TextEditor.

Declaration
public void SetShadow(Shadow shadow)
Parameters
Type Name Description
Shadow shadow

The Shadow
Remarks

SetShadow specifies the shadow of the text through Shadow.

Examples

The following example demonstrates how to use the SetShadow method.

var shadow = new Tizen.NUI.Text.Shadow();
shadow.Offset = new Vector2(3, 3);
shadow.Color = new Color("#F1C40F");
editor.SetShadow(shadow);
View Source

SetStrikethrough(Strikethrough)

Set Strikethrough to TextEditor.

Declaration
public void SetStrikethrough(Strikethrough strikethrough)
Parameters
Type Name Description
Strikethrough strikethrough

The Strikethrough
Remarks

SetStrikethrough specifies the strikethrough of the text through Strikethrough.

Examples

The following example demonstrates how to use the SetStrikethrough method.

var strikethrough = new Tizen.NUI.Text.Strikethrough();
strikethrough.Enable = true;
strikethrough.Color = new Color("#3498DB");
strikethrough.Height = 2.0f;
editor.SetStrikethrough(strikethrough);
View Source

SetUnderline(Underline)

Set Underline to TextEditor.

Declaration
public void SetUnderline(Underline underline)
Parameters
Type Name Description
Underline underline

The Underline
Remarks

SetUnderline specifies the underline of the text through Underline.

Examples

The following example demonstrates how to use the SetUnderline method.

var underline = new Tizen.NUI.Text.Underline();
underline.Enable = true;
underline.Color = new Color("#3498DB");
underline.Height = 2.0f;
editor.SetUnderline(underline);

Events

View Source

AnchorClicked

The AnchorClicked signal is emitted when the anchor is clicked.

Declaration
public event EventHandler<AnchorClickedEventArgs> AnchorClicked
Event Type
Type Description
EventHandler<><AnchorClickedEventArgs>
View Source

CursorPositionChanged

The CursorPositionChanged event is emitted whenever the primary cursor position changed.

Declaration
public event EventHandler CursorPositionChanged
Event Type
Type Description
EventHandler
View Source

InputFiltered

The InputFiltered signal is emitted when the input is filtered by InputFilter.

Declaration
public event EventHandler<InputFilteredEventArgs> InputFiltered
Event Type
Type Description
EventHandler<><InputFilteredEventArgs>
Remarks

See InputFilterType and InputFilteredEventArgs for a detailed description.

Examples

The following example demonstrates how to use the InputFiltered event.

editor.InputFiltered += (s, e) =>
{
    if (e.Type == InputFilterType.Accept)
    {
        // If input is filtered by InputFilter of Accept type.
    }
    else if (e.Type == InputFilterType.Reject)
    {
        // If input is filtered by InputFilter of Reject type.
    }
};
View Source

MaxLengthReached

The MaxLengthReached event.

Declaration
public event EventHandler<TextEditor.MaxLengthReachedEventArgs> MaxLengthReached
Event Type
Type Description
EventHandler<><MaxLengthReachedEventArgs>
View Source

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<><ScrollStateChangedEventArgs>
View Source

SelectionChanged

The SelectionChanged event is emitted whenever the selected text is changed.

Declaration
public event EventHandler SelectionChanged
Event Type
Type Description
EventHandler
View Source

SelectionCleared

The SelectionCleared signal is emitted when selection is cleared.

Declaration
public event EventHandler SelectionCleared
Event Type
Type Description
EventHandler
View Source

SelectionStarted

The SelectionStarted event is emitted when the selection has been started.

Declaration
public event EventHandler SelectionStarted
Event Type
Type Description
EventHandler
View Source

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<><TextChangedEventArgs>

Implements

System.IDisposable

Extension Methods