Definition
- Namespace:
- Tizen.NUI.BaseComponents
- Assembly:
- Tizen.NUI.dll
- API Level:
- 3
A control which provides a single line editable text field.
public class TextField : View, IDynamicResourceHandler, IElement, INameScope, IElementController, System.IDisposable, IResourcesProvider
- Inheritance
-
- Implements
-
Constructors
Declaration
API Level: 3
View Source
TextField(Boolean)
Creates the TextField with setting the status of shown or hidden.
Declaration
public TextField(bool shown)
Parameters
| Type |
Name |
Description |
| Boolean |
shown |
false : Not displayed (hidden), true : displayed (shown)
|
Fields
Declaration
public static readonly BindableProperty CharacterSpacingProperty
Field Value
Declaration
public static readonly BindableProperty CursorBlinkDurationProperty
Field Value
Declaration
public static readonly BindableProperty CursorBlinkIntervalProperty
Field Value
Declaration
public static readonly BindableProperty CursorWidthProperty
Field Value
Declaration
public static readonly BindableProperty DecorationBoundingBoxProperty
Field Value
Declaration
public static readonly BindableProperty EllipsisPositionProperty
Field Value
Declaration
public static readonly BindableProperty EllipsisProperty
Field Value
Declaration
public static readonly BindableProperty EmbossProperty
Field Value
Declaration
public static readonly BindableProperty EnableCursorBlinkProperty
Field Value
Declaration
public static readonly BindableProperty EnableEditingProperty
Field Value
Declaration
public static readonly BindableProperty EnableFontSizeScaleProperty
Field Value
Declaration
public static readonly BindableProperty EnableGrabHandlePopupProperty
Field Value
Declaration
public static readonly BindableProperty EnableGrabHandleProperty
Field Value
Declaration
public static readonly BindableProperty EnableMarkupProperty
Field Value
Declaration
public static readonly BindableProperty EnableSelectionProperty
Field Value
Declaration
public static readonly BindableProperty EnableShiftSelectionProperty
Field Value
Declaration
public static readonly BindableProperty ExceedPolicyProperty
Field Value
Declaration
public static readonly BindableProperty FontFamilyProperty
Field Value
Declaration
public static readonly BindableProperty FontSizeScaleProperty
Field Value
Declaration
public static readonly BindableProperty FontStyleProperty
Field Value
Declaration
public static readonly BindableProperty GrabHandleColorProperty
Field Value
Declaration
public static readonly BindableProperty GrabHandleImageProperty
Field Value
Declaration
public static readonly BindableProperty GrabHandlePressedImageProperty
Field Value
Declaration
public static readonly BindableProperty HiddenInputSettingsProperty
Field Value
Declaration
public static readonly BindableProperty HorizontalAlignmentProperty
Field Value
Declaration
public static readonly BindableProperty InputColorProperty
Field Value
Declaration
public static readonly BindableProperty InputEmbossProperty
Field Value
Declaration
public static readonly BindableProperty InputFontFamilyProperty
Field Value
Declaration
public static readonly BindableProperty InputFontStyleProperty
Field Value
Declaration
public static readonly BindableProperty InputMethodSettingsProperty
Field Value
Declaration
public static readonly BindableProperty InputOutlineProperty
Field Value
Declaration
public static readonly BindableProperty InputPointSizeProperty
Field Value
Declaration
public static readonly BindableProperty InputShadowProperty
Field Value
Declaration
public static readonly BindableProperty InputUnderlineProperty
Field Value
Declaration
public static readonly BindableProperty MatchSystemLanguageDirectionProperty
Field Value
Declaration
public static readonly BindableProperty MaxLengthProperty
Field Value
Declaration
public static readonly BindableProperty OutlineProperty
Field Value
Declaration
public static readonly BindableProperty PixelSizeProperty
Field Value
Declaration
public static readonly BindableProperty PlaceholderProperty
Field Value
Declaration
public static readonly BindableProperty PlaceholderTextColorProperty
Field Value
Declaration
public static readonly BindableProperty PlaceholderTextFocusedProperty
Field Value
Declaration
public static readonly BindableProperty PlaceholderTextProperty
Field Value
Declaration
public static readonly BindableProperty PointSizeProperty
Field Value
Declaration
public static readonly BindableProperty PrimaryCursorColorProperty
Field Value
View Source
PrimaryCursorPositionProperty
PrimaryCursorPositionProperty
Declaration
public static readonly BindableProperty PrimaryCursorPositionProperty
Field Value
Declaration
public static readonly BindableProperty ScrollSpeedProperty
Field Value
Declaration
public static readonly BindableProperty ScrollThresholdProperty
Field Value
Declaration
public static readonly BindableProperty SecondaryCursorColorProperty
Field Value
Declaration
public static readonly BindableProperty SelectionHandleImageLeftProperty
Field Value
Declaration
public static readonly BindableProperty SelectionHandleImageRightProperty
Field Value
Declaration
public static readonly BindableProperty SelectionHandleMarkerImageLeftProperty
Field Value
Declaration
public static readonly BindableProperty SelectionHandleMarkerImageRightProperty
Field Value
Declaration
public static readonly BindableProperty SelectionHandlePressedImageLeftProperty
Field Value
Declaration
public static readonly BindableProperty SelectionHandlePressedImageRightProperty
Field Value
Declaration
public static readonly BindableProperty SelectionHighlightColorProperty
Field Value
Declaration
public static readonly BindableProperty SelectionPopupStyleProperty
Field Value
Declaration
public static readonly BindableProperty ShadowColorProperty
Field Value
Declaration
public static readonly BindableProperty ShadowOffsetProperty
Field Value
Declaration
public static readonly BindableProperty ShadowProperty
Field Value
Declaration
public static readonly BindableProperty TextColorProperty
Field Value
Declaration
public static readonly BindableProperty TextProperty
Field Value
View Source
TranslatablePlaceholderTextFocusedProperty
TranslatablePlaceholderTextFocused property
Declaration
public static readonly BindableProperty TranslatablePlaceholderTextFocusedProperty
Field Value
Declaration
public static readonly BindableProperty TranslatablePlaceholderTextProperty
Field Value
Declaration
public static readonly BindableProperty TranslatableTextProperty
Field Value
Declaration
public static readonly BindableProperty UnderlineProperty
Field Value
Declaration
public static readonly BindableProperty VerticalAlignmentProperty
Field Value
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
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
API Level: 3
View Source
CursorBlinkInterval
The CursorBlinkInterval property.
The time interval in seconds between cursor on/off states.
Declaration
public float CursorBlinkInterval { get; set; }
Property Value
API Level: 3
Declaration
public int CursorWidth { get; set; }
Property Value
API Level: 3
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
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
public bool Ellipsis { get; set; }
Property Value
API Level: 4
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
API Level: 9
View Source
Emboss
The Emboss property.
The default emboss parameters.
Declaration
public string Emboss { get; set; }
Property Value
API Level: 3
View Source
EnableCursorBlink
The EnableCursorBlink property.
Whether the cursor should blink or not.
Declaration
public bool EnableCursorBlink { get; set; }
Property Value
API Level: 3
View Source
EnableEditing
Enable editing in text control.
Declaration
public bool EnableEditing { get; set; }
Property Value
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
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
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
View Source
EnableMarkup
The EnableMarkup property.
Whether the mark-up processing is enabled.
Declaration
public bool EnableMarkup { get; set; }
Property Value
API Level: 3
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
API Level: 3
View Source
EnableShiftSelection
Enables selection of the text using the Shift key.
Declaration
public bool EnableShiftSelection { get; set; }
Property Value
View Source
ExceedPolicy
The ExceedPolicy property.
Specifies how the text is truncated when it does not fit.
Declaration
public int ExceedPolicy { get; set; }
Property Value
API Level: 3
View Source
FontFamily
The FontFamily property.
The requested font family to use.
Declaration
public string FontFamily { get; set; }
Property Value
API Level: 3
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
API Level: 9
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
API Level: 3
View Source
GrabHandleColor
The GrabHandleColor property.
Declaration
public Color GrabHandleColor { get; set; }
Property Value
Remarks
View Source
GrabHandleImage
The GrabHandleImage property.
The image to display for the grab handle.
Declaration
public string GrabHandleImage { get; set; }
Property Value
API Level: 3
View Source
GrabHandlePressedImage
The GrabHandlePressedImage property.
The image to display when the grab handle is pressed.
Declaration
public string GrabHandlePressedImage { get; set; }
Property Value
API Level: 3
View Source
HiddenInputSettings
The HiddenInputSettings property.
Hides the input characters and instead shows a default character for password or pin entry.
The hiddenInputSettings map contains the following keys :
| HiddenInputProperty.Mode (int) | The mode for input text display (Use HiddenInputModeType) |
| HiddenInputProperty.SubstituteCharacter (int) | All input characters are substituted by this character |
| HiddenInputProperty.SubstituteCount (int) | Length of text to show or hide, available when HideCount/ShowCount mode is used |
| HiddenInputProperty.ShowLastCharacterDuration (int) | Hide last character after this duration, available when ShowLastCharacter mode |
Declaration
public PropertyMap HiddenInputSettings { get; set; }
Property Value
Examples
The following example demonstrates how to set the HiddenInputSettings property.
PropertyMap map = new PropertyMap();
map.Add(HiddenInputProperty.Mode, new PropertyValue((int)HiddenInputModeType.ShowLastCharacter));
map.Add(HiddenInputProperty.ShowLastCharacterDuration, new PropertyValue(500));
map.Add(HiddenInputProperty.SubstituteCharacter, new PropertyValue(0x2A));
textField.HiddenInputSettings = map;
API Level: 3
View Source
HorizontalAlignment
The HorizontalAlignment property.
The line horizontal alignment.
Declaration
public HorizontalAlignment HorizontalAlignment { get; set; }
Property Value
API Level: 3
View Source
InputColor
The InputColor property.
The color of the new input text.
Declaration
public Vector4 InputColor { get; set; }
Property Value
API Level: 3
View Source
InputEmboss
The InputEmboss property.
The emboss parameters of the new input text.
Declaration
public string InputEmboss { get; set; }
Property Value
API Level: 3
View Source
InputFontFamily
The InputFontFamily property.
The font's family of the new input text.
Declaration
public string InputFontFamily { get; set; }
Property Value
API Level: 3
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
API Level: 3
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
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;
textField.InputMethodSettings = method.OutputMap;
API Level: 3
View Source
InputOutline
The InputOutline property.
The outline parameters of the new input text.
Declaration
public string InputOutline { get; set; }
Property Value
API Level: 3
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
API Level: 3
View Source
InputShadow
The InputShadow property.
The shadow parameters of the new input text.
Declaration
public string InputShadow { get; set; }
Property Value
API Level: 3
View Source
InputUnderline
The InputUnderline property.
The underline parameters of the new input text.
Declaration
public string InputUnderline { get; set; }
Property Value
API Level: 3
View Source
MatchSystemLanguageDirection
The text alignment to match the direction of the system language.
The default value is true.
Declaration
public bool MatchSystemLanguageDirection { get; set; }
Property Value
API Level: 6
View Source
MaxLength
The MaxLength property.
The maximum number of characters that can be inserted.
Declaration
public int MaxLength { get; set; }
Property Value
API Level: 3
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
API Level: 3
View Source
PixelSize
The PixelSize property.
The size of font in pixels.
Declaration
public float PixelSize { get; set; }
Property Value
API Level: 3
View Source
Placeholder
The Placeholder property.
The placeholder map contains the following keys :
| text (string) | The text to display when the TextField 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
Examples
The following example demonstrates how to set the Placeholder property.
PropertyMap propertyMap = new PropertyMap();
propertyMap.Add("text", new PropertyValue("Setting Placeholder Text"));
propertyMap.Add("textFocused", new PropertyValue("Setting Placeholder Text Focused"));
propertyMap.Add("color", new PropertyValue(Color.Red));
propertyMap.Add("fontFamily", new PropertyValue("Arial"));
propertyMap.Add("pointSize", new PropertyValue(12.0f));
PropertyMap fontStyleMap = new PropertyMap();
fontStyleMap.Add("weight", new PropertyValue("bold"));
fontStyleMap.Add("width", new PropertyValue("condensed"));
fontStyleMap.Add("slant", new PropertyValue("italic"));
propertyMap.Add("fontStyle", new PropertyValue(fontStyleMap));
TextField field = new TextField();
field.Placeholder = propertyMap;
API Level: 3
View Source
PlaceholderText
The PlaceholderText property.
The text to display when the TextField is empty and inactive.
Declaration
public string PlaceholderText { get; set; }
Property Value
API Level: 3
View Source
PlaceholderTextColor
The PlaceholderTextColor property.
Declaration
public Vector4 PlaceholderTextColor { get; set; }
Property Value
API Level: 3
View Source
PlaceholderTextFocused
The PlaceholderTextFocused property.
The text to display when the TextField is empty with input focus.
Declaration
public string PlaceholderTextFocused { get; set; }
Property Value
API Level: 3
View Source
PointSize
The PointSize property.
The size of font in points.
Declaration
public float PointSize { get; set; }
Property Value
API Level: 3
View Source
PrimaryCursorColor
The PrimaryCursorColor property.
The color to apply to the primary cursor.
Declaration
public Vector4 PrimaryCursorColor { get; set; }
Property Value
API Level: 3
View Source
PrimaryCursorPosition
PrimaryCursorPosition property.
Specify the position of the primary cursor (caret) in text control.
Declaration
public int PrimaryCursorPosition { get; set; }
Property Value
API Level: 10
View Source
ScrollSpeed
The ScrollSpeed property.
The scroll speed in pixels per second.
Declaration
public float ScrollSpeed { get; set; }
Property Value
API Level: 3
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
API Level: 3
View Source
SecondaryCursorColor
The SecondaryCursorColor property.
The color to apply to the secondary cursor.
Declaration
public Vector4 SecondaryCursorColor { get; set; }
Property Value
API Level: 3
View Source
SelectedText
The portion of the text that has been selected by the user.
Declaration
public string SelectedText { get; }
Property Value
API Level: 9
View Source
SelectedTextEnd
The end index for selection.
Declaration
public int SelectedTextEnd { get; }
Property Value
API Level: 9
View Source
SelectedTextStart
The start index for selection.
Declaration
public int SelectedTextStart { get; }
Property Value
API Level: 9
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
API Level: 3
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
API Level: 3
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
API Level: 3
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
API Level: 3
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
API Level: 3
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
API Level: 3
View Source
SelectionHighlightColor
The SelectionHighlightColor property.
The color of the selection highlight.
Declaration
public Vector4 SelectionHighlightColor { get; set; }
Property Value
API Level: 3
View Source
The SelectionPopupStyle property.
The style of the text selection popup can be set through SelectionPopupStyle property.
Declaration
public PropertyMap SelectionPopupStyle { get; set; }
Property Value
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
API Level: 3
Declaration
public Vector4 ShadowColor { get; set; }
Property Value
Remarks
API Level: 3
Declaration
public Vector2 ShadowOffset { get; set; }
Property Value
Remarks
API Level: 3
View Source
Text
The Text property.
The text to display in the UTF-8 format.
Declaration
public string Text { get; set; }
Property Value
API Level: 3
View Source
TextColor
The TextColor property.
The color of the text.
Declaration
public Color TextColor { get; set; }
Property Value
API Level: 3
View Source
TranslatablePlaceholderText
The TranslatablePlaceholderText property.
The text can set the SID value.
Declaration
public string TranslatablePlaceholderText { get; set; }
Property Value
API Level: 4
View Source
TranslatablePlaceholderTextFocused
The TranslatablePlaceholderTextFocused property.
The text can set the SID value.
Declaration
public string TranslatablePlaceholderTextFocused { get; set; }
Property Value
View Source
TranslatableText
The TranslatableText property.
The text can set the SID value.
Declaration
public string TranslatableText { get; set; }
Property Value
API Level: 4
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
API Level: 3
View Source
VerticalAlignment
The VerticalAlignment property.
The line vertical alignment.
Declaration
public VerticalAlignment VerticalAlignment { get; set; }
Property Value
API Level: 3
Methods
View Source
CreateViewStyle()
Get attributes, it is abstract function and must be override.
Declaration
protected override ViewStyle CreateViewStyle()
Returns
Overrides
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Overrides
API Level: 3
View Source
GetFontStyle()
Get FontStyle from TextField.
Declaration
public FontStyle GetFontStyle()
Returns
View Source
GetHiddenInput()
Get HiddenInput from TextField.
Declaration
public HiddenInput GetHiddenInput()
Returns
View Source
GetInputFilter()
Get InputFilter from TextField.
Declaration
public InputFilter GetInputFilter()
Returns
API Level: 9
View Source
GetInputFontStyle()
Get InputFontStyle from TextField.
Declaration
public FontStyle GetInputFontStyle()
Returns
View Source
GetInputMethodContext()
Get the InputMethodContext instance.
Declaration
public InputMethodContext GetInputMethodContext()
Returns
API Level: 5
Declaration
public Outline GetOutline()
Returns
| Type |
Description |
| Outline |
The Outline
|
View Source
GetPlaceholder()
Get Placeholder from TextField.
Declaration
public Placeholder GetPlaceholder()
Returns
View Source
GetSelectionHandleImage()
Get SelectionHandleImage from TextField.
Declaration
public SelectionHandleImage GetSelectionHandleImage()
Returns
Remarks
View Source
GetSelectionHandleMarkerImage()
Get SelectionHandleMarkerImage from TextField.
Declaration
public SelectionHandleImage GetSelectionHandleMarkerImage()
Returns
Remarks
View Source
GetSelectionHandlePressedImage()
Get SelectionHandlePressedImage from TextField.
Declaration
public SelectionHandleImage GetSelectionHandlePressedImage()
Returns
Remarks
Declaration
public Shadow GetShadow()
Returns
| Type |
Description |
| Shadow |
The Shadow
|
Remarks
View Source
GetStrikethrough()
Get Strikethrough from TextField.
Declaration
public Strikethrough GetStrikethrough()
Returns
View Source
GetUnderline()
Get Underline from TextField.
Declaration
public Underline GetUnderline()
Returns
View Source
ReleaseSwigCPtr(Runtime.InteropServices.HandleRef)
Declaration
protected override void ReleaseSwigCPtr(Runtime.InteropServices.HandleRef swigCPtr)
Parameters
| Type |
Name |
Description |
| Tizen.System.Runtime.InteropServices.HandleRef |
swigCPtr |
|
Overrides
View Source
SelectNone()
Clear selection of the text.
Valid when selection is activate.
Declaration
API Level: 9
View Source
SelectText(Int32, Int32)
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 |
| Int32 |
start |
The start index for selection.
|
| Int32 |
end |
The end index for selection.
|
API Level: 9
Declaration
public void SelectWholeText()
API Level: 9
View Source
SetFontStyle(FontStyle)
Set FontStyle to TextField.
Declaration
public void SetFontStyle(FontStyle fontStyle)
Parameters
| Type |
Name |
Description |
| FontStyle |
fontStyle |
The 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;
field.SetFontStyle(fontStyle);
View Source
SetHiddenInput(HiddenInput)
Set HiddenInput to TextField.
Declaration
public void SetHiddenInput(HiddenInput hiddenInput)
Parameters
| Type |
Name |
Description |
| HiddenInput |
hiddenInput |
The HiddenInput
|
Examples
The following example demonstrates how to use the SetHiddenInput method.
var hiddenInput = new Tizen.NUI.Text.HiddenInput();
hiddenInput.Mode = HiddenInputModeType.ShowLastCharacter;
hiddenInput.SubstituteCharacter = '★';
hiddenInput.SubstituteCount = 0;
hiddenInput.ShowLastCharacterDuration = 1000;
field.SetHiddenInput(hiddenInput);
View Source
SetInputFilter(InputFilter)
Set InputFilter to TextField.
Declaration
public void SetInputFilter(InputFilter inputFilter)
Parameters
| Type |
Name |
Description |
| InputFilter |
inputFilter |
The InputFilter
|
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
field.SetInputFilter(inputFilter); // acceptable inputs are 4, 5, 6, 7, 8, 9
API Level: 9
View Source
SetInputFontStyle(FontStyle)
Set InputFontStyle to TextField.
Declaration
public void SetInputFontStyle(FontStyle fontStyle)
Parameters
| Type |
Name |
Description |
| FontStyle |
fontStyle |
The 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;
field.SetInputFontStyle(fontStyle);
View Source
SetOutline(Outline)
Set Outline to TextField.
Declaration
public void SetOutline(Outline outline)
Parameters
| Type |
Name |
Description |
| Outline |
outline |
The 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");
field.SetOutline(outline);
View Source
SetPlaceholder(Placeholder)
Set Placeholder to TextField.
Declaration
public void SetPlaceholder(Placeholder placeholder)
Parameters
| Type |
Name |
Description |
| Placeholder |
placeholder |
The 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;
field.SetPlaceholder(placeholder);
View Source
SetSelectionHandleImage(SelectionHandleImage)
Set SelectionHandleImage to TextField.
Declaration
public void SetSelectionHandleImage(SelectionHandleImage selectionHandleImage)
Parameters
Remarks
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";
field.SetSelectionHandleImage(selectionHandleImage);
View Source
SetSelectionHandleMarkerImage(SelectionHandleImage)
Set SelectionHandleMarkerImage to TextField.
Declaration
public void SetSelectionHandleMarkerImage(SelectionHandleImage selectionHandleMarkerImage)
Parameters
Remarks
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";
field.SetSelectionHandleMarkerImage(selectionHandleMarkerImage);
View Source
SetSelectionHandlePressedImage(SelectionHandleImage)
Set SelectionHandlePressedImage to TextField.
Declaration
public void SetSelectionHandlePressedImage(SelectionHandleImage selectionHandlePressedImage)
Parameters
Remarks
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";
field.SetSelectionHandlePressedImage(selectionHandlePressedImage);
Declaration
public void SetShadow(Shadow shadow)
Parameters
| Type |
Name |
Description |
| Shadow |
shadow |
The Shadow
|
Remarks
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");
field.SetShadow(shadow);
View Source
SetStrikethrough(Strikethrough)
Set Strikethrough to TextField.
Declaration
public void SetStrikethrough(Strikethrough strikethrough)
Parameters
| Type |
Name |
Description |
| Strikethrough |
strikethrough |
The 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;
field.SetStrikethrough(strikethrough);
View Source
SetUnderline(Underline)
Set Underline to TextField.
Declaration
public void SetUnderline(Underline underline)
Parameters
| Type |
Name |
Description |
| Underline |
underline |
The 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;
field.SetUnderline(underline);
Events
View Source
AnchorClicked
The AnchorClicked signal is emitted when the anchor is clicked.
Declaration
public event EventHandler<AnchorClickedEventArgs> AnchorClicked
Event Type
API Level: 9
View Source
CursorPositionChanged
The CursorPositionChanged event is emitted whenever the primary cursor position changed.
Declaration
public event EventHandler CursorPositionChanged
Event Type
| Type |
Description |
| EventHandler |
|
API Level: 9
View Source
InputFiltered
The InputFiltered signal is emitted when the input is filtered by InputFilter.
Declaration
public event EventHandler<InputFilteredEventArgs> InputFiltered
Event Type
Examples
The following example demonstrates how to use the InputFiltered event.
field.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.
}
};
API Level: 9
View Source
MaxLengthReached
The MaxLengthReached event.
Declaration
public event EventHandler<TextField.MaxLengthReachedEventArgs> MaxLengthReached
Event Type
API Level: 3
View Source
SelectionChanged
The SelectionChanged event is emitted whenever the selected text is changed.
Declaration
public event EventHandler SelectionChanged
Event Type
| Type |
Description |
| EventHandler |
|
API Level: 9
View Source
SelectionCleared
The SelectionCleared signal is emitted when selection is cleared.
Declaration
public event EventHandler SelectionCleared
Event Type
| Type |
Description |
| EventHandler |
|
API Level: 9
View Source
SelectionStarted
The SelectionStarted event is emitted when the selection has been started.
Declaration
public event EventHandler SelectionStarted
Event Type
| Type |
Description |
| EventHandler |
|
API Level: 10
Declaration
public event EventHandler<TextField.TextChangedEventArgs> TextChanged
Event Type
API Level: 3
Implements
Extension Methods