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, INotifyPropertyChanged, IDisposable
    Inheritance
    object
    BindableObject
    Tizen.NUI.Binding.Element
    BaseHandle
    Animatable
    Container
    View
    TextEditor
    Implements
    System.ComponentModel.INotifyPropertyChanged
    System.IDisposable

    Constructors

    View Source

    TextEditor()

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

    Declaration
    public TextEditor()

    Properties

    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

    EnableCursorBlink

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

    Declaration
    public bool EnableCursorBlink { 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

    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

    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

    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

    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

    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

    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

    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
    Exceptions
    Type Condition
    System.ArgumentNullException

    ResourceManager about multilingual is null.

    View Source

    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.

    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

    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
    View.Dispose(DisposeTypes)
    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

    GetInputFilter()

    Get InputFilter from TextEditor.

    Declaration
    public InputFilter GetInputFilter()
    Returns
    Type Description
    InputFilter

    The InputFilter

    Remarks

    InputFilter

    View Source

    GetInputMethodContext()

    Get the InputMethodContext instance.

    Declaration
    public InputMethodContext GetInputMethodContext()
    Returns
    Type Description
    InputMethodContext

    The InputMethodContext instance.

    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

    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

    Events

    View Source

    AnchorClicked

    The AnchorClicked signal is emitted when the anchor is clicked.

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

    CursorPositionChanged

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

    Declaration
    public event EventHandler CursorPositionChanged
    Event Type
    Type Description
    System.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
    System.EventHandler<TEventArgs><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

    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
    System.EventHandler<TEventArgs><TextEditor.ScrollStateChangedEventArgs>
    View Source

    SelectionChanged

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

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

    SelectionCleared

    The SelectionCleared signal is emitted when selection is cleared.

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

    SelectionStarted

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

    Declaration
    public event EventHandler SelectionStarted
    Event Type
    Type Description
    System.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
    System.EventHandler<TEventArgs><TextEditor.TextChangedEventArgs>

    Implements

    System.ComponentModel.INotifyPropertyChanged
    System.IDisposable
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX